@cabify/eslint-config 1.0.2 → 1.0.3

package/.github/workflows/npm-publish.yml

@@ -1,30 +1,13 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-
 name: Publish package
 
 on:
-  workflow_run:
-    workflows: ['Tests']
-    branches: [main]
-    types:
-      - completed
-  push:
-    branches:
-      - '!*'
-    tags:
-      - 'v*'
+  release:
+    types: [created]
 
 jobs:
   publish-npm:
-    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'yarn'
-      - uses: JS-DevTools/npm-publish@v1
-        with:
-          token: ${{ secrets.NPM_TOKEN }}
+    uses: cabify/javascript-actions/.github/workflows/npm_publish.yml@main
+    with:
+      tag: ${{ contains(github.ref_name,'beta') && 'beta' || 'latest' }}
+    secrets:
+      token: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/tests.yml

@@ -1,23 +1,7 @@
-# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
 name: Tests
 
-on: [push, pull_request]
+on: [push]
 
 jobs:
   test:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: 14.x
-          cache: 'yarn'
-      - run: yarn install
-      - name: Run Lint
-        run: yarn lint:check
-      - name: Run Format
-        run: yarn format:check
+    uses: cabify/javascript-actions/.github/workflows/tests.yml@main

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.3] - 2022-07-22
+
+### Changed
+
+- Bump dependencies
+
 ## [1.0.2] - 2021-11-25
 
 ### Changed

package/README.md

@@ -169,6 +169,8 @@ some rules. If you can live without them, just make these changes in your `.esli
 
 If you use Jest, installing its import resolver into your project is encouraged.
 
+1.  Install the following dependencies:
+
 ```sh
 npm i -D eslint-import-resolver-jest
 ```
@@ -179,6 +181,42 @@ or
 yarn add --dev eslint-import-resolver-jest
 ```
 
+2. Modify `.eslintrc`:
+
+```json
+{
+  ...
+  "settings": {
+    ...
+    "import/resolver": {
+      ...
+      "jest": {
+      "jestConfigFile": "./jest.config.js"
+      }
+    }
+  }
+}
+```
+
+If you want to ensure that this resolver only applies to your test files, you can use ESLint's overrides configuration option:
+
+```json
+"overrides": [
+  {
+    "files": ["**/__tests__/**/*.js"],
+    "settings": {
+      "import/resolver": {
+        "jest": {
+          "jestConfigFile": "./jest.config.js"
+        }
+      }
+    }
+  }
+]
+```
+
+3. Make sure that you have set up your jest config file (e.g., `./jest.config.js` )
+
 ## Legacy
 
 If you want to maintain the formatting within ESLint, you can opt to extend the `@cabify/eslint-config/legacy` configuration instead of `@cabify/eslint-config/recommended`:
@@ -190,15 +228,16 @@ If you want to maintain the formatting within ESLint, you can opt to extend the
 }
 ```
 
-## Publish new version
-
-Just merge to `main` branch and run:
+### Publish a new version
 
-- `git checkout main`
-- `git pull`
-- `yarn`
-- `yarn publish:(major|minor|patch)`
-- `git push --tags`
+- Update [CHANGELOG](./CHANGELOG.md) with new features, breaking changes, etc
+- Check you're in `main` branch and everything is up-to-date.
+- Run `yarn publish:<major|minor|patch>` or `yarn publish:canary` for canary versions.
+- Run `git push && git push --tags`
+- Check all test actions triggered after previous push are ✔️.
+- Go to [create a new release](https://github.com/cabify/eslint-config/releases/new), select previously pushed tag and write a Title.
+- Check the action for publish the npm has finished with success.
+- [Check on npm package webpage](https://www.npmjs.com/package/@cabify/eslint-config), the version has been published successfully under `latest` tag.
 
 This will trigger a workflow on Github which will publish to npm eventually.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cabify/eslint-config",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "ESLint config for Cabify Javascript projects",
   "scripts": {
     "test": "npm run lint:check && npm run format:check",
@@ -8,10 +8,12 @@
     "lint:check": "eslint .",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
+    "typecheck": "echo 'No typecheck to perform'",
+    "test:ci": "echo 'No test to perform'",
     "publish:major": "npm version major",
     "publish:minor": "npm version minor",
     "publish:patch": "npm version patch",
-    "publish:canary": "npm version prerelease"
+    "publish:canary": "npm version prerelease --preid=beta"
   },
   "license": "Apache-2.0",
   "repository": "github:cabify/eslint-config",
@@ -42,7 +44,7 @@
     "confusing-browser-globals": "^1.0.10",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-jest": "^25.3.0",
+    "eslint-plugin-jest": "^26.0.0",
     "eslint-plugin-jsx-a11y": "^6.5.1",
     "eslint-plugin-lodash": "^7.3.0",
     "eslint-plugin-prettier": "^4.0.0",
@@ -55,8 +57,8 @@
     "prettier": ">= 2.2.1"
   },
   "devDependencies": {
-    "eslint": "8.3.0",
-    "prettier": "2.4.1"
+    "prettier": "2.7.1",
+    "eslint": "8.20.0"
   },
   "publishConfig": {
     "access": "public"