From b8d5c2669e10acbdba5b48d8c07f7aa2a4121774 Mon Sep 17 00:00:00 2001 From: Wadjih Bencheikh Date: Wed, 2 Mar 2022 08:14:36 +0100 Subject: [PATCH] refactor: cleanup (#13) Refs: https://github.com/mljs/ml/issues/174 --- .babelrc => .babelrc.json | 0 .github/workflows/documentationjs.yml | 21 +++++++++++++++ .github/workflows/nodejs.yml | 37 ++++----------------------- .github/workflows/release.yml | 37 ++++++--------------------- .prettierrc => .prettierrc.json | 0 package.json | 17 ++++++------ src/__tests__/test.test.js | 8 +++--- 7 files changed, 47 insertions(+), 73 deletions(-) rename .babelrc => .babelrc.json (100%) create mode 100644 .github/workflows/documentationjs.yml rename .prettierrc => .prettierrc.json (100%) diff --git a/.babelrc b/.babelrc.json similarity index 100% rename from .babelrc rename to .babelrc.json diff --git a/.github/workflows/documentationjs.yml b/.github/workflows/documentationjs.yml new file mode 100644 index 0000000..0ae90e1 --- /dev/null +++ b/.github/workflows/documentationjs.yml @@ -0,0 +1,21 @@ +name: Deploy documentation.js on GitHub pages + +on: + workflow_dispatch: + release: + types: [published] + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Build documentation + uses: zakodium/documentationjs-action@v1 + - name: Deploy to GitHub pages + uses: JamesIves/github-pages-deploy-action@releases/v4 + with: + token: ${{ secrets.BOT_TOKEN }} + branch: gh-pages + folder: docs + clean: true diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml index 9566127..0ea7496 100644 --- a/.github/workflows/nodejs.yml +++ b/.github/workflows/nodejs.yml @@ -6,36 +6,9 @@ on: - master pull_request: -env: - NODE_VERSION: 16.x - jobs: - lint: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 - with: - node-version: ${{ env.NODE_VERSION }} - - name: Install dependencies - run: npm install - - name: Run ESLint - run: npm run eslint - test: - runs-on: ubuntu-latest - strategy: - matrix: - node-version: [10.x, 12.x, 14.x, 16.x] - fail-fast: false - steps: - - uses: actions/checkout@v2 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v2 - with: - node-version: ${{ matrix.node-version }} - - name: Install dependencies - run: npm install - - name: Run tests - run: npm run test-coverage - - name: Send coverage report to Codecov - uses: codecov/codecov-action@v2 + nodejs: + # Documentation: https://github.com/zakodium/workflows#nodejs-ci + uses: zakodium/workflows/.github/workflows/nodejs.yml@nodejs-v1 + with: + node-version-matrix: '[12, 14, 16]' diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 943cabf..29735ef 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -5,33 +5,12 @@ on: branches: - master -env: - NODE_VERSION: 14.x - jobs: - release-please: - runs-on: ubuntu-latest - steps: - - name: Get package name - run: echo "PACKAGE_NAME=$(jq .name package.json | tr -d '"')" >> $GITHUB_ENV - - uses: GoogleCloudPlatform/release-please-action@v2 - id: release - with: - token: ${{ secrets.BOT_TOKEN }} - release-type: node - package-name: ${{ env.PACKAGE_NAME }} - bump-minor-pre-major: Yes - - uses: actions/checkout@v2 - # These if statements ensure that a publication only occurs when a new release is created - if: ${{ steps.release.outputs.release_created }} - - uses: actions/setup-node@v2 - with: - node-version: ${{ env.NODE_VERSION }} - registry-url: 'https://registry.npmjs.org' - if: ${{ steps.release.outputs.release_created }} - - run: npm install - if: ${{ steps.release.outputs.release_created }} - - run: npm publish --access public - env: - NODE_AUTH_TOKEN: ${{ secrets.NPM_BOT_TOKEN }} - if: ${{ steps.release.outputs.release_created }} + release: + # Documentation: https://github.com/zakodium/workflows#release + uses: zakodium/workflows/.github/workflows/release.yml@release-v1 + with: + npm: true + secrets: + github-token: ${{ secrets.BOT_TOKEN }} + npm-token: ${{ secrets.NPM_BOT_TOKEN }} diff --git a/.prettierrc b/.prettierrc.json similarity index 100% rename from .prettierrc rename to .prettierrc.json diff --git a/package.json b/package.json index f854189..ac38ef2 100644 --- a/package.json +++ b/package.json @@ -15,10 +15,11 @@ "compile": "rollup -c", "eslint": "eslint src", "eslint-fix": "npm run eslint -- --fix", - "prepublishOnly": "npm run compile", - "test": "npm run test-coverage && npm run eslint", - "test-coverage": "jest --coverage", - "test-only": "jest" + "prepack": "npm run compile", + "prettier": "prettier --check src", + "prettier-write": "prettier --write src", + "test": "npm run test-only && npm run eslint && npm run prettier", + "test-only": "jest --coverage" }, "repository": { "type": "git", @@ -39,10 +40,10 @@ }, "devDependencies": { "@babel/plugin-transform-modules-commonjs": "^7.16.8", - "eslint": "^8.7.0", - "eslint-config-cheminfo": "^7.2.1", - "jest": "^27.4.7", + "eslint": "^8.10.0", + "eslint-config-cheminfo": "^7.2.2", + "jest": "^27.5.1", "prettier": "^2.5.1", - "rollup": "^2.65.0" + "rollup": "^2.68.0" } } diff --git a/src/__tests__/test.test.js b/src/__tests__/test.test.js index 767101a..9c90d3e 100644 --- a/src/__tests__/test.test.js +++ b/src/__tests__/test.test.js @@ -74,11 +74,11 @@ describe('base regression', () => { it('should throw error if inputs are not arrays or has different length', () => { const basic = new Basic(2); expect(() => { - basic.score(1, 2) - }).toThrow("x and y must be arrays of the same length"); + basic.score(1, 2); + }).toThrow('x and y must be arrays of the same length'); expect(() => { - basic.score([1, 2], [2]) - }).toThrow("x and y must be arrays of the same length"); + basic.score([1, 2], [2]); + }).toThrow('x and y must be arrays of the same length'); }); });