@toptal/davinci-syntax 11.0.2 → 11.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 11.1.0
+
+### Minor Changes
+
+- [#1072](https://github.com/toptal/davinci/pull/1072) [`0b93a80c`](https://github.com/toptal/davinci/commit/0b93a80c005d723503cb9dd3520505a450dc0d0b) Thanks [@MrBra1nwash](https://github.com/MrBra1nwash)! - [SP-1771] Add import/no-relative-packages rule
+
 ## 11.0.2
 
 ### Patch Changes

package/dist-package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-syntax",
-  "version": "11.0.2",
+  "version": "11.1.0",
   "description": "Lint and prettier support",
   "publishConfig": {
     "access": "public"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-syntax",
-  "version": "11.0.2",
+  "version": "11.1.0",
   "description": "Lint and prettier support",
   "publishConfig": {
     "access": "public"

package/src/{__snapshots__ → __tests__/__snapshots__}/eslint.test.ts.snap

@@ -184,6 +184,9 @@ exports[`eslint config verifies eslint rules are not updated silently 1`] = `
   'import/no-extraneous-dependencies': [
     'error',
   ],
+  'import/no-relative-packages': [
+    'warn',
+  ],
   '@typescript-eslint/array-type': [
     'error',
     {

package/src/__tests__/eslint-package-structure/bar.js

@@ -0,0 +1,2 @@
+export default 'bar'
+export const foo = () => 'foo'

package/src/__tests__/eslint-package-structure/package/index.js

@@ -0,0 +1 @@
+export default () => {}

package/src/__tests__/eslint-package-structure/package/package.json

@@ -0,0 +1,4 @@
+{
+  "description": "Unnamed package",
+  "main": "index.js"
+}

package/src/__tests__/eslint-package-structure/package-named/index.js

@@ -0,0 +1 @@
+export default () => {}

package/src/__tests__/eslint-package-structure/package-named/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "package-named",
+  "description": "Standard, named package",
+  "main": "index.js"
+}

package/src/__tests__/eslint-package-structure/package-scoped/index.js

@@ -0,0 +1 @@
+export default () => {}

package/src/__tests__/eslint-package-structure/package-scoped/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "@scope/package-named",
+  "description": "Scoped, named package",
+  "main": "index.js"
+}

package/src/{eslint.test.ts → __tests__/eslint.test.ts}

@@ -3,8 +3,8 @@ import { ESLint, Linter } from 'eslint'
 import json5 from 'json5'
 
 const getConfig = () => {
-  const pathToEslintrc = path.join(__dirname, '../src/configs/.eslintrc')
-  
+  const pathToEslintrc = path.join(__dirname, '../../src/configs/.eslintrc')
+
   return new ESLint({
     useEslintrc: false, // don't use any other eslintrc files (higher in the folder tree)
     overrideConfigFile: pathToEslintrc // use this exact eslintrc file

package/src/__tests__/no-relative-packages.test.js

@@ -0,0 +1,102 @@
+import { RuleTester } from 'eslint'
+import path from 'path'
+import rule from 'eslint-plugin-import/lib/rules/no-relative-packages'
+
+const testFilePath = relativePath =>
+  path.join(__dirname, '/eslint-package-structure', relativePath)
+
+const FILENAME = testFilePath('foo.js')
+
+const testRule = options => ({
+  filename: FILENAME,
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: 9,
+    ...options.parserOptions
+  },
+  ...options
+})
+
+const ruleTester = new RuleTester()
+
+ruleTester.run('no-relative-packages', rule, {
+  valid: [
+    testRule({
+      code: 'import foo from "./index.js"',
+      filename: testFilePath('./package/index.js')
+    }),
+    /**
+     * Unfortunately, this case is considered valid for the rule,
+     * but we cannot influence this. This case should be considered invalid.
+     *
+     * testRule({
+     *  code: 'import bar from "../bar"',
+     *  filename: testFilePath('./package/index.js')
+     * }),
+     */
+    testRule({
+      code: 'import { foo } from "a"',
+      filename: testFilePath('./package-named/index.js')
+    }),
+    testRule({
+      code: 'const bar = require("../bar.js")',
+      filename: testFilePath('./package/index.js')
+    }),
+    testRule({
+      code: 'import "package"',
+      filename: testFilePath('./package/index.js')
+    }),
+    testRule({
+      code: 'require("../bar.js")',
+      filename: testFilePath('./package/index.js')
+    })
+  ],
+  invalid: [
+    testRule({
+      code: 'import foo from "./package-named"',
+      filename: testFilePath('./bar.js'),
+      errors: [
+        {
+          message:
+            'Relative import from another package is not allowed. Use `package-named` instead of `./package-named`',
+          line: 1,
+          column: 17
+        }
+      ]
+    }),
+    testRule({
+      code: 'import foo from "../package-named"',
+      filename: testFilePath('./package/index.js'),
+      errors: [
+        {
+          message:
+            'Relative import from another package is not allowed. Use `package-named` instead of `../package-named`',
+          line: 1,
+          column: 17
+        }
+      ]
+    }),
+    testRule({
+      code: 'import foo from "../package-scoped"',
+      filename: testFilePath('./package/index.js'),
+      errors: [
+        {
+          message: `Relative import from another package is not allowed. Use \`@scope/package-named\` instead of \`../package-scoped\``,
+          line: 1,
+          column: 17
+        }
+      ]
+    }),
+    testRule({
+      code: 'import bar from "../bar"',
+      filename: testFilePath('./package-named/index.js'),
+      errors: [
+        {
+          message: `Relative import from another package is not allowed. Use \`@toptal/davinci-syntax/src/__test__/eslint-package-structure/bar\` instead of \`../bar\``,
+          line: 1,
+          column: 17
+        }
+      ]
+    })
+  ]
+})

package/src/configs/.eslintrc

@@ -175,6 +175,7 @@
       ["@toptal/picasso-shared", "@toptal/picasso-shared/**/*"]
     ],
     "import/no-extraneous-dependencies": "error",
+    "import/no-relative-packages": "warn",
     // typescript
     "@typescript-eslint/array-type": [
       "error",