Improved Resolution Handling (#9)

* feat: 🎸 use eslint-import-resolver logic to resolve

* feat: 🎸 remove unused dependencies

Remove unused dependencies and update the release to use
release.config.js

* ci: 🎡 add linting github action

* ci: 🎡 fix actions/setup-node to use semantic version

.github/workflows/lint_pr.yml

@@ -0,0 +1,22 @@
+name: Lint PR Changed Files
+on: 
+  # by adding a schedule task to this workflow we will automatically
+  # begin serializing read-only runs and handling them. The cron job
+  # below is set to run every 15 minutes, GitHub will ignore anything
+  # under 10 minutes and run every 10 minutes anyway.
+  schedule:
+    - cron: '*/30 * * * *'
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - closed
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: bradennapier/eslint-plus-action@v3.4.0
+      with: 
+        reportIgnoredFiles: true
+        reportWarningsAsErrors: true

.github/workflows/pull_request_ci.yml

@@ -9,14 +9,15 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node: [10.x, 12.x, 14.x]
 
     steps:
     - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+    - name: Use Node.js ${{ matrix.node }}
+      uses: actions/setup-node@v2.0.0
       with:
-        node-version: ${{ matrix.node-version }}
+        node-version: ${{ matrix.node }}
+        check-latest: true
     - name: npm install, build, and test
       run: |
         yarn install --pure-lockfile

.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2.0.0
         with:
           node-version: 12
       - name: Install dependencies

README.md

@@ -48,6 +48,7 @@
 - Provide import patterns that restrict imports of certain files based on location.
 - Ensure imports meet the expected guidelines within your repo.
 - Adapted from VSCode's rule `code-import-patterns`.
+- Works with configured `paths` from your `tsconfig.json`
 - Provide custom eslint messaging for each pattern if needed.
 - Useful in monorepos and most Typescript projects which utilize incremental builds.
 
@@ -59,10 +60,6 @@
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
-  parserOptions: {
-    project: './tsconfig.lint.json',
-    sourceType: 'module',
-  },
   rules: {
     'ts-import/patterns': [
       'error',
@@ -95,13 +92,10 @@ module.exports = {
       },
     ],
   },
-  plugins: ['ts-import'],
-  settings: {
-    'import/resolver': {
-      typescript: {
-        directory: 'tsconfig.lint.json',
-      },
-    },
-  },
+  plugins: ['ts-import']
 }
 ```
+
+## Special Thanks
+
+- While originally utilizing custom logic, we since borrowed the resolving method used by [eslint-import-resolver-typescript](https://github.com/alexgorbatchev/eslint-import-resolver-typescript).

package.json

@@ -34,40 +34,48 @@
     "test": "echo Tests TODO"
   },
   "peerDependencies": {
-    "eslint": "^7.2.0",
-    "typescript": "^3.9.5"
+    "eslint": ">= 6 < 8",
+    "typescript": ">= 3"
   },
   "dependencies": {
-    "@zerollup/ts-helpers": "^1.7.18",
+    "debug": "^4.1.1",
+    "fast-glob": "^3.2.4",
+    "is-glob": "^4.0.1",
     "minimatch": "^3.0.4",
+    "resolve": "^1.17.0",
+    "tsconfig-paths": "^3.9.0",
     "tslib": "^2.0.0"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^5.0.1",
     "@semantic-release/git": "^9.0.0",
     "@semantic-release/npm": "^7.0.5",
+    "@types/debug": "^4.1.5",
     "@types/eslint": "^7.2.0",
-    "@typescript-eslint/eslint-plugin": "^3.3.0",
-    "@typescript-eslint/parser": "^3.3.0",
-    "@typescript-eslint/experimental-utils": "^3.3.0",
+    "@types/is-glob": "^4.0.1",
+    "@types/minimatch": "^3.0.3",
+    "@types/resolve": "^1.17.1",
+    "@typescript-eslint/eslint-plugin": "^3.6.1",
+    "@typescript-eslint/experimental-utils": "^3.6.1",
+    "@typescript-eslint/parser": "^3.6.1",
     "commitizen": "^4.1.2",
-    "eslint": "^7.2.0",
+    "eslint": "^7.4.0",
     "eslint-config-airbnb-base": "^14.2.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-import-resolver-typescript": "^2.0.0",
-    "eslint-plugin-flowtype": "^5.1.3",
-    "eslint-plugin-import": "^2.21.2",
+    "eslint-plugin-flowtype": "^5.2.0",
+    "eslint-plugin-import": "^2.22.0",
     "eslint-plugin-prettier": "^3.1.4",
     "eslint-plugin-promise": "^4.2.1",
-    "gh-pages": "^3.0.0",
+    "gh-pages": "^3.1.0",
     "git-cz": "^4.7.0",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.11",
     "prettier": "^2.0.5",
     "rimraf": "^3.0.2",
-    "semantic-release": "^17.0.8",
+    "semantic-release": "^17.1.1",
     "ts-node": "^8.10.2",
-    "typescript": "^3.9.5"
+    "typescript": "^3.9.6"
   },
   "files": [
     "lib/",
@@ -84,25 +92,6 @@
       "path": "git-cz"
     }
   },
-  "release": {
-    "branches": [
-      "master",
-      {
-        "name": "next",
-        "prerelease": "rc"
-      }
-    ],
-    "verifyConditions": [
-      "@semantic-release/changelog",
-      "@semantic-release/npm",
-      "@semantic-release/git"
-    ],
-    "prepare": [
-      "@semantic-release/changelog",
-      "@semantic-release/npm",
-      "@semantic-release/git"
-    ]
-  },
   "lint-staged": {
     "src/**/*.{ts,tsx}": [
       "eslint --fix"

release.config.js

@@ -0,0 +1,26 @@
+module.exports = {
+  plugins: [
+    [
+      '@semantic-release/commit-analyzer',
+      {
+        preset: 'conventionalcommits',
+      },
+    ],
+    [
+      '@semantic-release/release-notes-generator',
+      {
+        preset: 'conventionalcommits',
+      },
+    ],
+    '@semantic-release/npm',
+    [
+      // commits the changed files to git
+      '@semantic-release/git',
+      {
+        assets: ['package.json'],
+      },
+    ],
+    // creates the github release
+    '@semantic-release/github',
+  ],
+};