From ffd1e0e17751960766bb848187c2749d735e0d01 Mon Sep 17 00:00:00 2001 From: IvanZosimov Date: Fri, 3 Mar 2023 15:25:48 +0100 Subject: [PATCH] Update docs --- .eslintrc.js | 1 - .gitattributes | 1 + .prettierrc.js | 1 - docs/contributors.md | 1 + package.json | 4 ++-- 5 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.eslintrc.js b/.eslintrc.js index b20b0add..c78ea5ad 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,4 +1,3 @@ -// This is a reusable configuration file copied from https://github.com/actions/reusable-workflows/tree/main/reusable-configurations. Please don't make changes to this file as it's the subject of an automatic update. module.exports = { extends: [ 'eslint:recommended', diff --git a/.gitattributes b/.gitattributes index bff632db..535b415a 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,3 +1,4 @@ +* text=auto eol=lf dist/index.js -diff -merge dist/index.js linguist-generated=true .licenses/** -diff linguist-generated=true diff --git a/.prettierrc.js b/.prettierrc.js index 468cdb1e..d7133c79 100644 --- a/.prettierrc.js +++ b/.prettierrc.js @@ -1,4 +1,3 @@ -// This is a reusable configuration file copied from https://github.com/actions/reusable-workflows/tree/main/reusable-configurations. Please don't make changes to this file as it's the subject of an automatic update. module.exports = { printWidth: 80, tabWidth: 2, diff --git a/docs/contributors.md b/docs/contributors.md index 1d698c71..7196d482 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -60,6 +60,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub. - To implement new features or fix bugs, you need to make changes to the `.ts` files, which are located in the `src` folder - To comply with the code style, **you need to run the `format` script** +- To lint the code, **you need to run the `lint:fix` script** - To transpile source code to `javascript` we use [NCC](https://github.com/vercel/ncc). **It is very important to run the `build` script after making changes**, otherwise your changes will not get into the final `javascript` build **Learn more about how to implement tests:** diff --git a/package.json b/package.json index 3d653ab2..1c0bce76 100644 --- a/package.json +++ b/package.json @@ -6,8 +6,8 @@ "main": "dist/setup/index.js", "scripts": { "build": "ncc build -o dist/setup src/setup-java.ts && ncc build -o dist/cleanup src/cleanup-java.ts", - "format": "prettier --config ./.prettierrc.js --write **/*.{ts,yml,yaml}", - "format-check": "prettier --config ./.prettierrc.js --check **/*.{ts,yml,yaml}", + "format": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --write **/*.{ts,yml,yaml}", + "format-check": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --check **/*.{ts,yml,yaml}", "lint": "eslint --config ./.eslintrc.js **/*.ts", "lint:fix": "eslint --config ./.eslintrc.js **/*.ts --fix", "prerelease": "npm run-script build",