Merge pull request #9 from vitonsky/2-add-tests

test(#2): add tests

Author: vitonsky

.github/workflows/codeql-analysis.yml

@@ -8,14 +8,14 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ master ]
+    branches: [master]
   schedule:
     # At 04:35 AM, every 3 days
     # test expression on https://crontab.cronhub.io/
-    - cron: '35 4 */3 * *'
+    - cron: "35 4 */3 * *"
 
   workflow_dispatch:
 
@@ -28,7 +28,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '14'
+          node-version: "20"
 
       - name: Install deps
         run: npm install
@@ -47,40 +47,40 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript', 'TypeScript' ]
+        language: ["javascript", "TypeScript"]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v2
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+      #- run: |
+      #   make bootstrap
+      #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

src/import-paths.test.ts

@@ -0,0 +1,68 @@
+import { RuleTester } from 'eslint';
+import path from 'path';
+
+import rule from './import-paths';
+
+const tester = new RuleTester({
+	parserOptions: {
+		// eslint-disable-next-line spellcheck/spell-checker
+		ecmaVersion: 6,
+		sourceType: 'module',
+	},
+});
+
+tester.run('import-paths', rule, {
+	valid: [
+		{
+			name: 'relative import from not an alias directory are allowed',
+			filename: path.resolve('./src/index.ts'),
+			code: `import baz from './baz/index';`,
+		},
+		{
+			name: 'import from an alias root are possible',
+			filename: path.resolve('./src/index.ts'),
+			code: `import baz from '@foo';`,
+		},
+		{
+			name: 'files in alias directory may import files from the same alias',
+			filename: path.resolve('./src/foo/index.ts'),
+			code: `import z from '@foo/x/y/z';`,
+		},
+		{
+			name: 'files in alias directory may import files from another aliases',
+			filename: path.resolve('./src/foo/index.ts'),
+			code: `import z from '@bar/x/y/z';`,
+		},
+		{
+			name: 'relative imports from subdirectory is allowed for files inside alias',
+			filename: path.resolve('./src/foo/index.ts'),
+			code: `import z from './x/y/z';`,
+		},
+		{
+			name: 'relative imports from subdirectory is allowed for files inside alias (case with escalate directory)',
+			filename: path.resolve('./src/foo/x/y/z/index.ts'),
+			code: `import foo from '../../../index';`,
+		},
+		{
+			name: 'relative imports from subdirectory is allowed for files inside alias (case with out of alias directory)',
+			filename: path.resolve('./src/foo/x/y/z/index.ts'),
+			code: `import foo from '../../../../index';`,
+		},
+	],
+	invalid: [
+		{
+			name: 'relative import from alias must be fixed',
+			filename: path.resolve('./src/index.ts'),
+			code: `import z from './foo/x/y/z';`,
+			errors: ['Update import to @foo/x/y/z'],
+			output: `import z from '@foo/x/y/z';`,
+		},
+		{
+			name: 'relative import from alias used in another alias must be fixed',
+			filename: path.resolve('./src/foo/index.ts'),
+			code: `import z from '../bar/x/y/z';`,
+			errors: ['Update import to @bar/x/y/z'],
+			output: `import z from '@bar/x/y/z';`,
+		},
+	],
+});

src/eslint-local-rules.ts renamed to src/import-paths.ts

@@ -28,7 +28,12 @@
 		"rootDir": ".",
 		"allowJs": true,
 		"resolveJsonModule": true,
-		"skipLibCheck": true
+		"skipLibCheck": true,
+		"baseUrl": ".",
+		"paths": {
+			"@foo/*": ["src/foo/*"],
+			"@bar/*": ["src/bar/*"]
+		}
 	},
 	"include": ["src/*.ts", "src/*.tsx", "src/**/*.ts", "src/**/*.tsx"]
 }