@knotx/cli 0.4.3 → 0.4.5

package/dist/index.cjs

@@ -766,9 +766,12 @@ function createConfigFiles(targetDir) {
       const tsconfigTemplate = yield fs__default.readFile(safeResolvePath(templatesDir, "tsconfig.json.template"), "utf-8");
       const buildConfigTemplate = yield fs__default.readFile(safeResolvePath(templatesDir, "build.config.ts.template"), "utf-8");
       const eslintConfigTemplate = yield fs__default.readFile(safeResolvePath(templatesDir, "eslint.config.mjs.template"), "utf-8");
+      const vscodeSettingsTemplate = yield fs__default.readFile(safeResolvePath(templatesDir, ".vscode", "settings.json.template"), "utf-8");
+      yield safeEnsureDir(safeResolvePath(targetDir, ".vscode"));
       yield fs__default.writeFile(safeResolvePath(targetDir, "tsconfig.json"), tsconfigTemplate);
       yield fs__default.writeFile(safeResolvePath(targetDir, "build.config.ts"), buildConfigTemplate);
       yield fs__default.writeFile(safeResolvePath(targetDir, "eslint.config.mjs"), eslintConfigTemplate);
+      yield fs__default.writeFile(safeResolvePath(targetDir, ".vscode", "settings.json"), vscodeSettingsTemplate);
     } catch (error) {
       console.error("\u65E0\u6CD5\u8BFB\u53D6\u6A21\u677F\u6587\u4EF6:", error);
       const tsconfig = {
@@ -802,8 +805,7 @@ function createSourceFiles(targetDir, pluginName, environment) {
       const camelCaseName = toCamelCase(pluginNameWithoutScope);
       const pascalCaseName = toPascalCase(pluginNameWithoutScope);
       const indexTemplate = yield fs__default.readFile(safeResolvePath(templatesDir, "index.ts.template"), "utf-8");
-      const indexContent = indexTemplate.replace(/\{\{pluginName\}\}/g, camelCaseName);
-      yield fs__default.writeFile(safeResolvePath(targetDir, "src", "index.ts"), indexContent);
+      yield fs__default.writeFile(safeResolvePath(targetDir, "src", "index.ts"), indexTemplate);
       let templatePath;
       if (environment === "jsx") {
         templatePath = safeResolvePath(templatesDir, "plugin.jsx.template");
@@ -812,7 +814,7 @@ function createSourceFiles(targetDir, pluginName, environment) {
       }
       const pluginTemplate = yield fs__default.readFile(templatePath, "utf-8");
       const pluginContent = pluginTemplate.replace(/\{\{camelCaseName\}\}/g, camelCaseName).replace(/\{\{capitalizedPluginName\}\}/g, pascalCaseName);
-      const fileName = `${camelCaseName}.tsx`;
+      const fileName = "plugin.tsx";
       yield fs__default.writeFile(safeResolvePath(targetDir, "src", fileName), pluginContent);
       yield createPlayground(targetDir, pluginNameWithoutScope, camelCaseName, pascalCaseName, environment);
     } catch (error) {
@@ -835,7 +837,7 @@ function createPlayground(targetDir, pluginName, camelCaseName, pascalCaseName,
       );
       const fileExtension = isReact ? "tsx" : "ts";
       const viteConfigContent = viteConfigTemplate.replace(new RegExp("\\{\\{#if isReact\\}\\}(.*?)\\{\\{\\/if\\}\\}", "gs"), isReact ? "$1" : "");
-      const htmlContent = htmlTemplate.replace(/\{\{pluginName\}\}/g, pluginName).replace(/\{\{pluginNameWithoutScope\}\}/g, pluginName).replace(/\{\{camelCaseName\}\}/g, camelCaseName).replace(/\{\{capitalizedPluginName\}\}/g, pascalCaseName).replace(/\{\{fileExtension\}\}/g, fileExtension);
+      const htmlContent = htmlTemplate.replace(/\{\{fileExtension\}\}/g, fileExtension);
       const mainContent = mainTemplate.replace(/\{\{pluginName\}\}/g, pluginName).replace(/\{\{camelCaseName\}\}/g, camelCaseName).replace(/\{\{capitalizedPluginName\}\}/g, pascalCaseName);
       yield fs__default.writeFile(safeResolvePath(playgroundDir, "vite.config.ts"), viteConfigContent);
       yield fs__default.writeFile(safeResolvePath(playgroundDir, "index.html"), htmlContent);

package/dist/index.js

@@ -741,9 +741,12 @@ function createConfigFiles(targetDir) {
       const tsconfigTemplate = yield fs.readFile(safeResolvePath(templatesDir, "tsconfig.json.template"), "utf-8");
       const buildConfigTemplate = yield fs.readFile(safeResolvePath(templatesDir, "build.config.ts.template"), "utf-8");
       const eslintConfigTemplate = yield fs.readFile(safeResolvePath(templatesDir, "eslint.config.mjs.template"), "utf-8");
+      const vscodeSettingsTemplate = yield fs.readFile(safeResolvePath(templatesDir, ".vscode", "settings.json.template"), "utf-8");
+      yield safeEnsureDir(safeResolvePath(targetDir, ".vscode"));
       yield fs.writeFile(safeResolvePath(targetDir, "tsconfig.json"), tsconfigTemplate);
       yield fs.writeFile(safeResolvePath(targetDir, "build.config.ts"), buildConfigTemplate);
       yield fs.writeFile(safeResolvePath(targetDir, "eslint.config.mjs"), eslintConfigTemplate);
+      yield fs.writeFile(safeResolvePath(targetDir, ".vscode", "settings.json"), vscodeSettingsTemplate);
     } catch (error) {
       console.error("\u65E0\u6CD5\u8BFB\u53D6\u6A21\u677F\u6587\u4EF6:", error);
       const tsconfig = {
@@ -777,8 +780,7 @@ function createSourceFiles(targetDir, pluginName, environment) {
       const camelCaseName = toCamelCase(pluginNameWithoutScope);
       const pascalCaseName = toPascalCase(pluginNameWithoutScope);
       const indexTemplate = yield fs.readFile(safeResolvePath(templatesDir, "index.ts.template"), "utf-8");
-      const indexContent = indexTemplate.replace(/\{\{pluginName\}\}/g, camelCaseName);
-      yield fs.writeFile(safeResolvePath(targetDir, "src", "index.ts"), indexContent);
+      yield fs.writeFile(safeResolvePath(targetDir, "src", "index.ts"), indexTemplate);
       let templatePath;
       if (environment === "jsx") {
         templatePath = safeResolvePath(templatesDir, "plugin.jsx.template");
@@ -787,7 +789,7 @@ function createSourceFiles(targetDir, pluginName, environment) {
       }
       const pluginTemplate = yield fs.readFile(templatePath, "utf-8");
       const pluginContent = pluginTemplate.replace(/\{\{camelCaseName\}\}/g, camelCaseName).replace(/\{\{capitalizedPluginName\}\}/g, pascalCaseName);
-      const fileName = `${camelCaseName}.tsx`;
+      const fileName = "plugin.tsx";
       yield fs.writeFile(safeResolvePath(targetDir, "src", fileName), pluginContent);
       yield createPlayground(targetDir, pluginNameWithoutScope, camelCaseName, pascalCaseName, environment);
     } catch (error) {
@@ -810,7 +812,7 @@ function createPlayground(targetDir, pluginName, camelCaseName, pascalCaseName,
       );
       const fileExtension = isReact ? "tsx" : "ts";
       const viteConfigContent = viteConfigTemplate.replace(new RegExp("\\{\\{#if isReact\\}\\}(.*?)\\{\\{\\/if\\}\\}", "gs"), isReact ? "$1" : "");
-      const htmlContent = htmlTemplate.replace(/\{\{pluginName\}\}/g, pluginName).replace(/\{\{pluginNameWithoutScope\}\}/g, pluginName).replace(/\{\{camelCaseName\}\}/g, camelCaseName).replace(/\{\{capitalizedPluginName\}\}/g, pascalCaseName).replace(/\{\{fileExtension\}\}/g, fileExtension);
+      const htmlContent = htmlTemplate.replace(/\{\{fileExtension\}\}/g, fileExtension);
       const mainContent = mainTemplate.replace(/\{\{pluginName\}\}/g, pluginName).replace(/\{\{camelCaseName\}\}/g, camelCaseName).replace(/\{\{capitalizedPluginName\}\}/g, pascalCaseName);
       yield fs.writeFile(safeResolvePath(playgroundDir, "vite.config.ts"), viteConfigContent);
       yield fs.writeFile(safeResolvePath(playgroundDir, "index.html"), htmlContent);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knotx/cli",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "description": "CLI tool for Knotx",
   "author": "boenfu",
   "license": "MIT",
@@ -42,9 +42,9 @@
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",
     "@types/inquirer": "^9.0.7",
-    "@knotx/build-config": "0.4.3",
-    "@knotx/eslint-config": "0.4.3",
-    "@knotx/typescript-config": "0.4.3"
+    "@knotx/build-config": "0.4.5",
+    "@knotx/eslint-config": "0.4.5",
+    "@knotx/typescript-config": "0.4.5"
   },
   "scripts": {
     "build": "unbuild",

package/templates/.vscode/settings.json.template

@@ -0,0 +1,64 @@
+{
+  // Enable the ESlint flat config support
+  "eslint.experimental.useFlatConfig": true,
+  // Disable the default formatter, use eslint instead
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+  // Auto fix
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "explicit",
+    "source.organizeImports": "never"
+  },
+  // Silent the stylistic rules in you IDE, but still auto fix them
+  "eslint.rules.customizations": [
+    {
+      "rule": "style/*",
+      "severity": "off"
+    },
+    {
+      "rule": "*-indent",
+      "severity": "off"
+    },
+    {
+      "rule": "*-spacing",
+      "severity": "off"
+    },
+    {
+      "rule": "*-spaces",
+      "severity": "off"
+    },
+    {
+      "rule": "*-order",
+      "severity": "off"
+    },
+    {
+      "rule": "*-dangle",
+      "severity": "off"
+    },
+    {
+      "rule": "*-newline",
+      "severity": "off"
+    },
+    {
+      "rule": "*quotes",
+      "severity": "off"
+    },
+    {
+      "rule": "*semi",
+      "severity": "off"
+    }
+  ],
+  // Enable eslint for all supported languages
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "html",
+    "markdown",
+    "json",
+    "jsonc",
+    "yaml"
+  ]
+}

package/templates/index.ts.template

@@ -1 +1 @@
-export * from './{{pluginName}}'
+export * from './plugin'

package/templates/playground/index.html.template

@@ -1,9 +1,9 @@
 <!DOCTYPE html>
-<html lang="zh-CN">
+<html lang="en">
 <head>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>{{capitalizedPluginName}} Plugin Playground</title>
+  <title>Plugin Playground</title>
   <style>
     body {
       margin: 0;
@@ -27,11 +27,11 @@
 </head>
 <body>
   <div class="container">
-    <h1>{{capitalizedPluginName}} Plugin Demo</h1>
-    <p>这是 {{pluginNameWithoutScope}} 插件的演示页面。您可以在这里测试插件的功能。</p>
+    <h1>Plugin Playground</h1>
+    <p>Demo and testing environment for the plugin.</p>
     
     <div id="app">
-      <!-- 插件内容将在这里展示 -->
+      <!-- Plugin content will be rendered here -->
     </div>
   </div>
   

package/templates/playground/tsconfig.json.template

@@ -2,8 +2,11 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "jsx": "react-jsx",
+    "rootDir": "..",
     "types": ["vite/client"],
+    "noEmit": true,
     "esModuleInterop": true
   },
-  "include": ["."]
+  "include": [".", "../src"],
+  "exclude": ["vite.config.ts"]
 }