eslint-plugin-semi-design 0.0.1

package/LICENSE

@@ -0,0 +1,83 @@
+MIT License
+
+Copyright (c) 2021 DouyinFE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+The code implementation of the external library is referenced by DouyinFe are:
+
+- animate.css
+
+    The MIT License (MIT)
+
+    Copyright (c) 2020 Daniel Eden
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE.
+
+- Ant Design
+    MIT LICENSE
+
+    Copyright (c) 2015-present Ant UED, https://xtech.antfin.com/
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+- rc-tree
+
+    MIT LICENSE
+
+    Copyright (c) 2015-present Alipay.com, https://www.alipay.com/
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README-zh_CN.md

@@ -0,0 +1,55 @@
+# eslint-plugin-semi-design
+
+Semi 仓库使用的 eslint 插件
+
+## eslint 规则
+
+### ✅ 不能在 semi-foundation 里引用 semi-ui
+
+semi-ui 不应该作为 semi-foundation 的依赖。
+
+原因：根据 Semi 的 foundation 和 adapter 设计，foundation 不应依赖 adapter。点击查看 [F/A 设计](https://bytedance.feishu.cn/wiki/wikcnOVYexosCS1Rmvb5qCsWT1f)。
+
+### ✅ 不能在 semi-ui 和 semi-foundation 引用 lodash-es
+
+使用 lodash 而不是 lodash-es。
+
+原因：为了兼容 next，而 lodash-es 只提供了 es module 的产物。
+
+![image](https://user-images.githubusercontent.com/26477537/172051379-30b42f31-b677-43be-982f-1e8f5345cfc9.png)
+
+点击查看[详情](https://github.com/vercel/next.js/issues/2259)。
+
+### ✅ 不能在 semi-ui 或 semi-foundation 使用相对路径引用 pacakges 下的包
+
+monorepo 下各个包之间的 import 请使用包名而不是相对路径。
+
+原因：这两个包在用户项目的安装路径可能不在同一文件夹下，使用相对路径会找不到对应的包。
+
+```javascript
+// ❌ 不推荐
+// semi-ui/input/index.tsx
+import inputFoundation from '../semi-foundation/input/foundation';
+
+// ✅ 推荐
+// semi-ui/input/index.tsx
+import inputFoundation from '@douyinfe/semi-foundation/input/foundation';
+```
+
+### ✅ 不推荐在同个包下使用包名加路径引用其他模块
+
+同一个包 import 请使用相对路径而不是引用包名。
+
+```javascript
+// ❌ 不推荐
+// semi-ui/modal/Modal.tsx
+import { Button } from '@douyinfe/semi-ui';
+
+// ✅ 推荐
+// semi-ui/modal/Modal.tsx
+import Button from '../button';
+```
+
+## 相关资料
+
+- eslint plugin 文档：https://eslint.org/docs/developer-guide/working-with-plugins

package/README.md

@@ -0,0 +1,55 @@
+# `semi-eslint-plugin`
+
+eslint plugin for semi design
+
+## Rules
+
+### ✅ Should not reference semi-ui in semi-foundation
+
+semi-ui should not be used as a dependency of semi-foundation.
+
+Why: According to Semi's foundation and adapter design, foundation should not depend on adapter. Click to view the [F/A design](https://bytedance.feishu.cn/wiki/wikcnOVYexosCS1Rmvb5qCsWT1f).
+
+### ✅ Should not import lodash-es in semi-ui and semi-foundation
+
+Use lodash instead of lodash-es.
+
+Why: In order to be compatible with next, lodash-es only provides the product of es module.
+
+![image](https://user-images.githubusercontent.com/26477537/172051379-30b42f31-b677-43be-982f-1e8f5345cfc9.png)
+
+See more [here](https://github.com/vercel/next.js/issues/2259)。
+
+### ✅ Should not use relative paths to import a package under pacakges in semi-ui or semi-foundation
+
+For imports between packages under monorepo, use package names instead of relative paths.
+
+Why: These two packages may not be in the same folder in the installation path of the user project, and the corresponding package cannot be found using the relative path.
+
+```javascript
+// ❌ Not recommend
+// semi-ui/input/index.tsx
+import inputFoundation from '../semi-foundation/input/foundation';
+
+// ✅ Recommend
+// semi-ui/input/index.tsx
+import inputFoundation from '@douyinfe/semi-foundation/input/foundation';
+```
+
+### ✅ Should not use the package name and path to import other modules under the same package
+When importing the same package, use relative paths instead of referencing the package name.
+
+```javascript
+// ❌ Not recommend
+// semi-ui/modal/Modal.tsx
+import { Button } from '@douyinfe/semi-ui';
+
+// ✅ Recommend
+// semi-ui/modal/Modal.tsx
+import Button from '../button';
+
+```
+
+## Related docs
+
+- eslint plugin doc：https://eslint.org/docs/developer-guide/working-with-plugins

package/lib/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rules = void 0;
+const rules_1 = require("./rules");
+exports.rules = rules_1.default;

package/lib/rules/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const no_import_1 = require("./no-import");
+exports.default = {
+    'no-import': no_import_1.default,
+};

package/lib/rules/no-import.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const SEMI_PACKAGE_REG = /(?<=packages\/|@douyinfe\/|\.\.\/)(semi-[\w-]+)/;
+const RELATIVE_PATH_REG = /(..\/)+semi-[\w-]+/;
+const rule = {
+    meta: {
+        type: "problem",
+        docs: {
+            description: "disable import statement",
+            recommended: true,
+            url: "https://github.com/DouyinFE/semi-design"
+        },
+        fixable: "code",
+        messages: {
+            unexpected: "Unexpected import statement, semi ui should not be used as a dependency of semi foundation",
+            unexpectedLodashES: "Unexpected import statement, please use lodash instead of lodash-es.",
+            unexpectedRelativeImport: "Unexpected import statement, please use module name instead of relative path.",
+            unexpectedImportSelf: 'Unexpected import statement, please use relative paths to import modules in the same package.'
+        },
+        schema: [],
+    },
+    create(context) {
+        return {
+            ImportDeclaration: (node) => {
+                const fileName = context.getFilename();
+                const sourceCode = context.getSourceCode();
+                const importName = node.source.raw;
+                const isFoundationFile = fileName.includes('semi-foundation');
+                const isUIFile = fileName.includes('semi-ui');
+                const importText = sourceCode.getText(node);
+                if (isFoundationFile) {
+                    if (importName.includes('semi-ui')) {
+                        context.report({ node, messageId: "unexpected" });
+                    }
+                }
+                if (isFoundationFile || isUIFile) {
+                    if (importName.includes('lodash-es')) {
+                        const fixedSource = importText.replace('lodash-es', 'lodash');
+                        context.report({
+                            node,
+                            messageId: "unexpectedLodashES",
+                            fix: (fixer) => {
+                                return fixer.replaceText(node, fixedSource);
+                            }
+                        });
+                    }
+                    else if (importName.includes('semi-')) {
+                        if (isImportRelativePackage({ path: importName, fileName })) {
+                            const importPackageName = SEMI_PACKAGE_REG.exec(importName)[0];
+                            const fixedSource = importText.replace(RELATIVE_PATH_REG, `@douyinfe/${importPackageName}`);
+                            context.report({
+                                node,
+                                messageId: "unexpectedRelativeImport",
+                                fix: (fixer) => {
+                                    return fixer.replaceText(node, fixedSource);
+                                }
+                            });
+                        }
+                        else if (isImportSelf({ path: importName, fileName })) {
+                            context.report({
+                                node,
+                                messageId: "unexpectedImportSelf",
+                            });
+                        }
+                    }
+                }
+            }
+        };
+    }
+};
+function isRelativePath(path) {
+    return path.includes('../');
+}
+function isImportRelativePackage(options) {
+    const { path, fileName } = options;
+    const currentPackageName = SEMI_PACKAGE_REG.exec(fileName)[0];
+    const importPackageName = SEMI_PACKAGE_REG.exec(path)[0];
+    return currentPackageName !== importPackageName && isRelativePath(path);
+}
+function isImportSelf(options) {
+    const { path, fileName } = options;
+    const currentPackageName = SEMI_PACKAGE_REG.exec(fileName)[0];
+    const importPackageName = SEMI_PACKAGE_REG.exec(path)[0];
+    return currentPackageName === importPackageName;
+}
+exports.default = rule;

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "eslint-plugin-semi-design",
+  "version": "0.0.1",
+  "description": "semi ui eslint plugin",
+  "keywords": [
+    "semi",
+    "eslint"
+  ],
+  "author": "shijia.me <shijia.me@bytedance.com>",
+  "homepage": "https://semi.design",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "lib",
+    "README.md",
+    "README-zh_CN.md"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DouyinFE/semi-design.git"
+  },
+  "scripts": {
+    "build:lib": "rm -rf lib && tsc",
+    "prepublishOnly": "npm run build:lib",
+    "test": "node __tests__/index.js"
+  },
+  "devDependencies": {
+    "typescript": "^4"
+  },
+  "peerDependencies": {
+    "eslint": ">=0.8.0"
+  },
+  "bugs": {
+    "url": "https://github.com/DouyinFE/semi-design/issues"
+  },
+  "gitHead": "2484e493d4a9b1914f6fca4a890cb967420c4524"
+}