easy-soft-develop 2.1.174 → 2.1.177

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "easy-soft-develop",
-  "version": "2.1.174",
+  "version": "2.1.177",
   "description": "",
   "homepage": "https://github.com/kityandhero/easy-soft-develop#readme",
   "bugs": {
@@ -99,7 +99,7 @@
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-promise": "^6.2.0",
     "husky": "^9.0.11",
     "lint-staged": "^15.2.5",
     "npm-check-updates": "^16.14.20",

package/src/cliCollection/create-assist-scripts.cli.js

@@ -4,6 +4,7 @@ const {
   createCommitlintConfigFile,
   createBabelConfigFile,
   createNcuConfigFile,
+  createJsdocConfigFile,
   createNpmConfigFile,
 } = require('../tools/develop.file');
 
@@ -18,5 +19,6 @@ exports.run = function () {
   createCommitlintConfigFile();
   createBabelConfigFile();
   createNcuConfigFile();
+  createJsdocConfigFile();
   createNpmConfigFile();
 };

package/src/project/initProject.js

@@ -16,6 +16,7 @@ const {
   createCommitlintConfigFile,
   createBabelConfigFile,
   createNcuConfigFile,
+  createJsdocConfigFile,
   createNpmConfigFile,
   createCzConfigFile,
 } = require('../tools/develop.file');
@@ -277,6 +278,7 @@ function createRepositoryProject(name) {
   createCzConfigFile(`step *: create .czrc success`);
   createBabelConfigFile(`step *: create babel.config.js success`);
   createNcuConfigFile(`step *: create .ncurc.js success`);
+  createJsdocConfigFile(`step *: create .jsdoc.js success`);
   createNpmConfigFile(`step *: create .npmrc success`);
   createDevelopFiles('', `step *: create develop folder success`);
   createHusky();

package/src/templates/jsdoc.template.js

@@ -0,0 +1,60 @@
+const { fileGlobalHeader } = require('./template.config');
+
+const folderPath = './develop/config/jsdoc';
+
+const configFileContent = `${fileGlobalHeader}
+module.exports = {
+  generalConfig: {
+    tags: {
+      allowUnknownTags: false,
+      dictionaries: ['jsdoc', 'closure'],
+    },
+    source: {
+      include: './src',
+    },
+    plugins: ['plugins/markdown'],
+    opts: {
+      template: 'node_modules/docdash',
+      encoding: 'utf8',
+      destination: 'docs/',
+      recurse: true,
+      verbose: true,
+    },
+    templates: {
+      cleverLinks: false,
+      monospaceLinks: false,
+    },
+  },
+};
+`;
+
+const configFile = {
+  folderPath: `${folderPath}/config`,
+  fileName: 'index.js',
+  coverFile: false,
+  fileContent: configFileContent,
+};
+
+const contentFileContent = `${fileGlobalHeader}
+const packageContent = \`${fileGlobalHeader}
+const { generalConfig } = require("../../develop/config/jsdoc/config");
+
+module.exports = generalConfig;
+\`;
+
+module.exports = {
+  packageContent,
+};
+`;
+
+const contentFile = {
+  folderPath: `${folderPath}/template`,
+  fileName: 'content.js',
+  coverFile: true,
+  fileContent: contentFileContent,
+};
+
+module.exports = {
+  configFile,
+  contentFile,
+};

package/src/templates/package.template.js

@@ -7,11 +7,10 @@ const commitScript = {
   precommit: 'npm run z:lint:staged:quiet',
 };
 
-const documentationScript = {
-  'prez:documentation:generate': 'npm run z:documentation:clear && npm run z:documentation:lint',
-  'z:documentation:generate': 'npx documentation build src/** -f html --github -o docs',
-  'z:documentation:lint': 'npx documentation lint src/**',
-  'z:documentation:clear': 'npx easy-soft-develop rimraf --path ./docs',
+const jsdocScript = {
+  'prez:jsdoc:generate': 'npm run z:jsdoc:clear',
+  'z:jsdoc:generate': 'npx jsdoc -c .jsdoc.json',
+  'z:jsdoc:clear': 'npx easy-soft-develop rimraf --path ./docs',
 };
 
 const lintScript = {
@@ -51,7 +50,7 @@ const jestScript = {
 
 module.exports = {
   ...commitScript,
-  ...documentationScript,
+  ...jsdocScript,
   ...lintScript,
   ...prettierScript,
   ...tscScript,

package/src/tools/develop.file.js

@@ -63,6 +63,10 @@ const {
   contentFile: ncuContentFile,
   configFile: ncuConfigFile,
 } = require('../templates/ncu.template');
+const {
+  contentFile: jsdocContentFile,
+  configFile: jsdocConfigFile,
+} = require('../templates/jsdoc.template');
 const {
   ignoreFile: stylelintIgnoreFile,
   contentFile: stylelintContentFile,
@@ -222,6 +226,16 @@ function createNcuConfigFile(successMessage = '') {
   }
 }
 
+function createJsdocConfigFile(successMessage = '') {
+  let result = writeFileWithOptionsSync(jsdocContentFile);
+
+  if (result) {
+    if (!checkStringIsEmpty(successMessage)) {
+      promptSuccess(successMessage);
+    }
+  }
+}
+
 function createNpmConfigFile(successMessage = '') {
   let result = writeFileSync(
     `./.npmrc`,
@@ -385,6 +399,7 @@ const { initialEnvironment } = require('easy-soft-develop');
 
 const eslintFile = require('../config/eslint/template/content');
 const ncuFile = require('../config/ncu/template/content');
+const jsdocFile = require('../config/jsdoc/template/content');
 const eslintIgnoreFile = require('../config/eslint/template/ignore.content');
 const prettierFile = require('../config/prettier/template/content');
 const prettierIgnoreFile = require('../config/prettier/template/ignore.content');
@@ -407,6 +422,8 @@ const packageEslintFileContent = eslintFile.packageContent;
 const mainNcuFileContent = ncuFile.mainContent;
 const packageNcuFileContent = ncuFile.packageContent;
 
+const packageJsdocFileContent = jsdocFile.packageContent;
+
 const eslintIgnoreContent = eslintIgnoreFile.content;
 
 const mainPrettierContent = prettierFile.mainContent;
@@ -498,6 +515,11 @@ const packageFileContentList = [
     content: packageNcuFileContent,
     coverFile: true,
   },
+  {
+    name: '.jsdoc.js',
+    content: packageJsdocFileContent,
+    coverFile: true,
+  },
   {
     name: '.prettierrc.js',
     content: packagePrettierContent,
@@ -680,6 +702,14 @@ function createDevelopFiles(
 
   //#endregion
 
+  //#region jsdoc
+
+  writeFileWithOptionsSync(jsdocContentFile);
+
+  writeFileWithOptionsSync(jsdocConfigFile);
+
+  //#endregion
+
   //#region stylelint
 
   writeFileWithOptionsSync(stylelintIgnoreFile);
@@ -724,6 +754,7 @@ module.exports = {
   createCommitlintConfigFile,
   createBabelConfigFile,
   createNcuConfigFile,
+  createJsdocConfigFile,
   createNpmConfigFile,
   createCleanScriptFile,
   createPackageCheckSpecialVersionScriptFile,

package/src/tools/package.dependence.js

@@ -42,7 +42,7 @@ function getGlobalDevelopPackages() {
     'eslint-plugin-unicorn',
   ]);
 
-  packages = packages.concat(['documentation']);
+  packages = packages.concat(['jsdoc', 'docdash']);
 
   packages = packages.concat([
     'prettier',

package/types/templates/jsdoc.template.d.ts

@@ -0,0 +1,18 @@
+export namespace configFile {
+  export let folderPath: string;
+  export let fileName: string;
+  export let coverFile: boolean;
+  export { configFileContent as fileContent };
+}
+export namespace contentFile {
+  let folderPath_1: string;
+  export { folderPath_1 as folderPath };
+  let fileName_1: string;
+  export { fileName_1 as fileName };
+  let coverFile_1: boolean;
+  export { coverFile_1 as coverFile };
+  export { contentFileContent as fileContent };
+}
+declare const configFileContent: "/* eslint-disable no-undef */\n/* eslint-disable import/no-commonjs */\n/* eslint-disable unicorn/prefer-module */\n/* eslint-disable no-useless-escape */\n\nmodule.exports = {\n  generalConfig: {\n    tags: {\n      allowUnknownTags: false,\n      dictionaries: ['jsdoc', 'closure'],\n    },\n    source: {\n      include: './src',\n    },\n    plugins: ['plugins/markdown'],\n    opts: {\n      template: 'node_modules/docdash',\n      encoding: 'utf8',\n      destination: 'docs/',\n      recurse: true,\n      verbose: true,\n    },\n    templates: {\n      cleverLinks: false,\n      monospaceLinks: false,\n    },\n  },\n};\n";
+declare const contentFileContent: '/* eslint-disable no-undef */\n/* eslint-disable import/no-commonjs */\n/* eslint-disable unicorn/prefer-module */\n/* eslint-disable no-useless-escape */\n\nconst packageContent = `/* eslint-disable no-undef */\n/* eslint-disable import/no-commonjs */\n/* eslint-disable unicorn/prefer-module */\n/* eslint-disable no-useless-escape */\n\nconst { generalConfig } = require("../../develop/config/jsdoc/config");\n\nmodule.exports = generalConfig;\n`;\n\nmodule.exports = {\n  packageContent,\n};\n';
+export {};

package/types/templates/package.template.d.ts

@@ -31,7 +31,7 @@ export namespace customChildPackageFile {
   export { coverFile_3 as coverFile };
   export { customChildPackageFileContent as fileContent };
 }
-declare const globalChildPackageFileContent: "/* eslint-disable no-undef */\n/* eslint-disable import/no-commonjs */\n/* eslint-disable unicorn/prefer-module */\n/* eslint-disable no-useless-escape */\n\nconst commitScript = {\n  precommit: 'npm run z:lint:staged:quiet',\n};\n\nconst documentationScript = {\n  'prez:documentation:generate': 'npm run z:documentation:clear && npm run z:documentation:lint',\n  'z:documentation:generate': 'npx documentation build src/** -f html --github -o docs',\n  'z:documentation:lint': 'npx documentation lint src/**',\n  'z:documentation:clear': 'npx easy-soft-develop rimraf --path ./docs',\n};\n\nconst lintScript = {\n  'z:lint:file:all': 'npm run z:lint:script:all && npm run z:lint:style:all',\n  'z:lint:file:all:fix': 'npm run z:lint:script:all:fix && npm run z:lint:style:all:fix',\n  'z:lint:file:change': 'npm run z:lint:script:change && npm run z:lint:style:all',\n  'z:lint:file:change:fix': 'npm run z:lint:script:change:fix && npm run z:lint:style:all:fix',\n  'z:lint:script:all': 'npx eslint --ext .js,.jsx,.ts,.tsx ./src',\n  'z:lint:script:all:fix': 'npx eslint --fix --ext .js,.jsx,.ts,.tsx ./src',\n  'postz:lint:script:all:fix': 'npm run z:prettier:format:all',\n  'z:lint:script:change': 'npx eslint --cache --ext .js,.jsx,.ts,.tsx ./src',\n  'z:lint:script:change:fix': 'npx eslint --fix --cache --ext .js,.jsx,.ts,.tsx ./src',\n  'postz:lint:script:change:fix': 'npm run z:prettier:format:change',\n  'z:lint:staged': 'npx lint-staged',\n  'z:lint:staged:quiet': 'npx lint-staged --quiet',\n  'z:lint:style:all': 'npx stylelint --allow-empty-input \"./src/**/*.{css,scss,less}\"',\n  'z:lint:style:all:fix': 'npx stylelint --allow-empty-input --fix \"./src/**/*.{css,scss,less}\"',\n  'postz:lint:style:all:fix': 'npm run z:prettier:format:all',\n  'z:lint:style:change': 'npx stylelint --allow-empty-input --cache \"./src/**/*.{css,scss,less}\"',\n  'z:lint:style:change:fix': 'npx stylelint --allow-empty-input --cache --fix \"./src/**/*.{css,scss,less}\"',\n  'postz:lint:style:change:fix': 'npm run z:prettier:format:change',\n};\n\nconst prettierScript = {\n  'z:prettier:format:all': 'npx prettier --write .',\n  'z:prettier:format:change': 'npx prettier --cache --write .',\n  'z:prettier:package.json': 'npx prettier --write ./package.json',\n};\n\nconst tscScript = {\n  'z:tsc:build': 'echo show tsc version and create declaration file && tsc -v && tsc -p ./tsconfig.types.json && echo declaration file generate complete',\n};\n\nconst jestScript = {\n  'z:test': 'cross-env NODE_ENV=test jest',\n};\n\nmodule.exports = {\n  ...commitScript,\n  ...documentationScript,\n  ...lintScript,\n  ...prettierScript,\n  ...tscScript,\n  ...jestScript,\n};\n";
+declare const globalChildPackageFileContent: "/* eslint-disable no-undef */\n/* eslint-disable import/no-commonjs */\n/* eslint-disable unicorn/prefer-module */\n/* eslint-disable no-useless-escape */\n\nconst commitScript = {\n  precommit: 'npm run z:lint:staged:quiet',\n};\n\nconst jsdocScript = {\n  'prez:jsdoc:generate': 'npm run z:jsdoc:clear',\n  'z:jsdoc:generate': 'npx jsdoc -c .jsdoc.json',\n  'z:jsdoc:clear': 'npx easy-soft-develop rimraf --path ./docs',\n};\n\nconst lintScript = {\n  'z:lint:file:all': 'npm run z:lint:script:all && npm run z:lint:style:all',\n  'z:lint:file:all:fix': 'npm run z:lint:script:all:fix && npm run z:lint:style:all:fix',\n  'z:lint:file:change': 'npm run z:lint:script:change && npm run z:lint:style:all',\n  'z:lint:file:change:fix': 'npm run z:lint:script:change:fix && npm run z:lint:style:all:fix',\n  'z:lint:script:all': 'npx eslint --ext .js,.jsx,.ts,.tsx ./src',\n  'z:lint:script:all:fix': 'npx eslint --fix --ext .js,.jsx,.ts,.tsx ./src',\n  'postz:lint:script:all:fix': 'npm run z:prettier:format:all',\n  'z:lint:script:change': 'npx eslint --cache --ext .js,.jsx,.ts,.tsx ./src',\n  'z:lint:script:change:fix': 'npx eslint --fix --cache --ext .js,.jsx,.ts,.tsx ./src',\n  'postz:lint:script:change:fix': 'npm run z:prettier:format:change',\n  'z:lint:staged': 'npx lint-staged',\n  'z:lint:staged:quiet': 'npx lint-staged --quiet',\n  'z:lint:style:all': 'npx stylelint --allow-empty-input \"./src/**/*.{css,scss,less}\"',\n  'z:lint:style:all:fix': 'npx stylelint --allow-empty-input --fix \"./src/**/*.{css,scss,less}\"',\n  'postz:lint:style:all:fix': 'npm run z:prettier:format:all',\n  'z:lint:style:change': 'npx stylelint --allow-empty-input --cache \"./src/**/*.{css,scss,less}\"',\n  'z:lint:style:change:fix': 'npx stylelint --allow-empty-input --cache --fix \"./src/**/*.{css,scss,less}\"',\n  'postz:lint:style:change:fix': 'npm run z:prettier:format:change',\n};\n\nconst prettierScript = {\n  'z:prettier:format:all': 'npx prettier --write .',\n  'z:prettier:format:change': 'npx prettier --cache --write .',\n  'z:prettier:package.json': 'npx prettier --write ./package.json',\n};\n\nconst tscScript = {\n  'z:tsc:build': 'echo show tsc version and create declaration file && tsc -v && tsc -p ./tsconfig.types.json && echo declaration file generate complete',\n};\n\nconst jestScript = {\n  'z:test': 'cross-env NODE_ENV=test jest',\n};\n\nmodule.exports = {\n  ...commitScript,\n  ...jsdocScript,\n  ...lintScript,\n  ...prettierScript,\n  ...tscScript,\n  ...jestScript,\n};\n";
 declare const customMainPackageFileContent: '/* eslint-disable no-undef */\n/* eslint-disable import/no-commonjs */\n/* eslint-disable unicorn/prefer-module */\n/* eslint-disable no-useless-escape */\n\nconst scripts = {};\n\nmodule.exports = {\n  ...scripts,\n};\n';
 declare const customChildPackageFileContent: '/* eslint-disable no-undef */\n/* eslint-disable import/no-commonjs */\n/* eslint-disable unicorn/prefer-module */\n/* eslint-disable no-useless-escape */\n\nconst scripts = {};\n\nmodule.exports = {\n  ...scripts,\n};\n';
 export {};

package/types/tools/develop.file.d.ts

@@ -2,6 +2,7 @@ export function createCzConfigFile(successMessage?: string): void;
 export function createCommitlintConfigFile(successMessage?: string): void;
 export function createBabelConfigFile(successMessage?: string): void;
 export function createNcuConfigFile(successMessage?: string): void;
+export function createJsdocConfigFile(successMessage?: string): void;
 export function createNpmConfigFile(successMessage?: string): void;
 export function createCleanScriptFile(): boolean;
 export function createPackageCheckSpecialVersionScriptFile(): void;
@@ -10,5 +11,8 @@ export function createInstallGlobalDevelopDependenceScriptFile(): void;
  * Create initial environment script files
  */
 export function createInitialEnvironmentScriptFiles(): void;
-export function createDevelopFiles(waitMessage?: string, successMessage?: string): void;
+export function createDevelopFiles(
+  waitMessage?: string,
+  successMessage?: string,
+): void;
 export function createUpdatePackageFromPackageScriptFile(): boolean;