From e74b3f5597a3bc8eb8762455ad63b0c7f0dbfda4 Mon Sep 17 00:00:00 2001 From: Arthur Lu Date: Tue, 29 Nov 2022 22:38:22 +0000 Subject: [PATCH] add prettier requirements and commands, add prettier ADR, add prettier action --- .github/workflows/prettier.yml | 29 +++++++++++++++++++++++++++++ package.json | 7 +++++-- specs/adrs/112922-prettier.md | 17 +++++++++++++++++ 3 files changed, 51 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/prettier.yml create mode 100644 specs/adrs/112922-prettier.md diff --git a/.github/workflows/prettier.yml b/.github/workflows/prettier.yml new file mode 100644 index 0000000..8003d23 --- /dev/null +++ b/.github/workflows/prettier.yml @@ -0,0 +1,29 @@ +name: Prettier + +on: + pull_request: + branches: + - main + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +jobs: + # Single deploy job since we're just deploying + test: + runs-on: ubuntu-latest + steps: + - name: Install apt updates + run: sudo apt -y update; sudo apt -y upgrade; + - name: Install prerequisites + uses: actions/setup-node@v3 + with: + node-version: 18 + - name: Checkout + uses: actions/checkout@v3 + - name: Install dependencies + run: sudo npm install + - name: Start local http server + run: sudo npm run http-server & + - name: Run tests + run: sudo npm lint-prettier \ No newline at end of file diff --git a/package.json b/package.json index f9ca927..abf2630 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,9 @@ "lint-css": "stylelint **/*.css", "fix-css": "stylelint --fix **/*.css", "http-server": "http-server source", - "js-doc": "jsdoc -d source/docs/ -r source/" + "js-doc": "jsdoc -d source/docs/ -r source/", + "lint-prettier": "prettier --check .", + "fix-prettier": "prettier --write ." }, "devDependencies": { "eslint": "^8.27.0", @@ -21,6 +23,7 @@ "mock-local-storage": "^1.1.23", "puppeteer": "^18.2.1", "stylelint": "14.14.1", - "stylelint-config-standard": "^29.0.0" + "stylelint-config-standard": "^29.0.0", + "prettier": "2.8.0" } } diff --git a/specs/adrs/112922-prettier.md b/specs/adrs/112922-prettier.md new file mode 100644 index 0000000..d50440d --- /dev/null +++ b/specs/adrs/112922-prettier.md @@ -0,0 +1,17 @@ +# Use Prettier for generic style enforcement + +- Status: accept +- Deciders: Arthur Lu, Marc Reta +- Date: 11 / 29 / 22 + +## Decision Drivers + +- Other linters (HTML, CSS, JS) are sometimes too permissive +- Need to enforce style on other files like markdown, json + +## Considered Options +- Prettier + +## Decision Outcome + +Chosen Option: Prettier \ No newline at end of file