ims-template-config 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 eternallycyf Xu
+
+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.md

@@ -0,0 +1,134 @@
+<a name="readme-top"></a>
+
+<div align="center">
+
+[//]: # '<img width="160" src="https://avatars.githubusercontent.com/u/17870709?v=4">'
+
+<h1>ims-template-config</h1>
+
+一个开发 npm 项目的模板
+
+node 版本 v18.13.0
+
+[Changelog](./CHANGELOG.md) · [Report Bug][issues-url] · [Request Feature][issues-url]
+
+<!-- SHIELD GROUP -->
+
+[![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url] [![install size][npm-size]][npm-size-url]
+
+[![Test CI status][test-ci]][test-ci-url] [![Deploy CI][release-ci]][release-ci-url] [![Coverage][coverage]][codecov-url]
+
+[![contributors][contributors-shield]][contributors-url] [![forks][forks-shield]][forks-url] [![stargazers][stargazers-shield]][stargazers-url] [![issues][issues-shield]][issues-url]
+
+[![ docs by dumi][dumi-url]](https://d.umijs.org/) [![Build With father][father-url]](https://github.com/umijs/father/)
+
+![](https://github.com/othneildrew/Best-README-Template/raw/master/images/screenshot.png)
+
+<!-- gitpod url -->
+
+[gitpod-badge]: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod
+[gitpod-url]: https://gitpod.io/#https://github.com/ant-design/ims-template-config
+
+<!-- umi url -->
+
+[dumi-url]: https://img.shields.io/badge/docs%20by-dumi-blue
+[father-url]: https://img.shields.io/badge/build%20with-father-028fe4.svg
+
+<!-- npm url -->
+
+[npm-image]: http://img.shields.io/npm/v/ims-template-config.svg?style=flat-square&color=deepgreen&label=latest
+[npm-url]: http://npmjs.org/package/ims-template-config
+[npm-size]: https://img.shields.io/bundlephobia/minzip/ims-template-config?color=deepgreen&label=gizpped%20size&style=flat-square
+[npm-size-url]: https://packagephobia.com/result?p=ims-template-config
+
+<!-- coverage -->
+
+[coverage]: https://codecov.io/gh/eternallycyf/ims-template-config/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/eternallycyf/ims-template-config/branch/master
+
+<!-- Github CI -->
+
+[test-ci]: https://github.com/eternallycyf/ims-template-config/workflows/Test%20CI/badge.svg
+[release-ci]: https://github.com/eternallycyf/ims-template-config/workflows/Release%20CI/badge.svg
+[test-ci-url]: https://github.com/eternallycyf/ims-template-config/actions?query=workflow%3ATest%20CI
+[release-ci-url]: https://github.com/eternallycyf/ims-template-config/actions?query=workflow%3ARelease%20CI
+[download-image]: https://img.shields.io/npm/dm/ims-template-config.svg?style=flat-square
+[download-url]: https://npmjs.org/package/ims-template-config
+
+</div>
+
+## 简介
+
+这是一个开发 npm 项目的模板，具有以下特点：
+
+- 🏗️ **基于 father4 的构建工具**：本项目采用了基于 father4 的构建工具，可以更高效地构建项目，提高开发效率；
+- 📖 **基于 dumi2 的文档工具**：本项目采用了基于 dumi2 的文档工具，可以更方便地编写和管理文档，提高文档的可读性和可维护性；
+- 🚀 **基于 vercel 自动化触发文档站构建**：本项目使用 vercel 自动化触发文档站构建，可以更快地更新文档站，提高用户的使用体验；
+- 📦 **基于 semantic-release 实现 npm 包的自动化发布**：本项目使用 semantic-release 实现 npm 包的自动化发布，可以更方便地管理和发布 npm 包，提高开发效率。
+
+## 快速上手
+
+### 安装
+
+推荐使用 `pnpm` 安装
+
+```bash
+pnpm i ims-template-config -S
+```
+
+### 使用
+
+基于该仓库模板可以快速创建一个 npm 包的工程化脚手架。
+
+详情：[CHANGELOG](./CHANGELOG.md)
+
+## 🤝 Contributing
+
+<!-- CONTRIBUTION GROUP -->
+
+> 📊 Total: <kbd>**1**</kbd>
+
+<a href="https://github.com/eternallycyf" title="eternallycyf">
+  <img src="https://avatars.githubusercontent.com/u/63464198?v=4" width="50" />
+</a>
+
+<!-- CONTRIBUTION END -->
+
+<div align="right">
+
+[![][back-to-top]](#readme-top)
+
+## </div>
+
+#### 📝 License
+
+Copyright © 2020 - present [eternallycyf][profile-url]. <br />
+This project is [MIT](./LICENSE) licensed.
+
+<!-- LINK GROUP -->
+
+[profile-url]: https://github.com/eternallycyf
+
+<!-- SHIELD LINK GROUP -->
+
+[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
+
+<!-- contributors -->
+
+[contributors-shield]: https://img.shields.io/github/contributors/eternallycyf/ims-template-config.svg?style=flat
+[contributors-url]: https://github.com/eternallycyf/ims-template-config/graphs/contributors
+
+<!-- forks -->
+
+[forks-shield]: https://img.shields.io/github/forks/eternallycyf/ims-template-config.svg?style=flat
+[forks-url]: https://github.com/eternallycyf/ims-template-config/network/members
+
+<!-- stargazers -->
+
+[stargazers-shield]: https://img.shields.io/github/stars/eternallycyf/ims-template-config.svg?style=flat
+[stargazers-url]: https://github.com/eternallycyf/ims-template-config/stargazers
+
+<!-- issues -->
+
+[issues-shield]: https://img.shields.io/github/issues/eternallycyf/ims-template-config.svg?style=flat
+[issues-url]: https://github.com/eternallycyf/ims-template-config/issues/new/choose

package/es/components/footer/index.d.ts

@@ -0,0 +1,21 @@
+export declare const footer: ({
+    title: string;
+    items: ({
+        title: string;
+        url: string;
+        openExternal: boolean;
+    } | {
+        title: string;
+        url: string;
+        openExternal?: undefined;
+    })[];
+} | {
+    title: string;
+    items: {
+        title: string;
+        description: string;
+        url: string;
+        openExternal: boolean;
+    }[];
+})[];
+//# sourceMappingURL=index.d.ts.map

package/es/components/footer/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/footer/index.tsx"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;IA6FlB,CAAC"}

package/es/components/footer/index.js

@@ -0,0 +1,71 @@
+export var footer = [{
+  title: '相关依赖',
+  items: [{
+    title: 'ims-view-pc',
+    url: 'https://ims-view.site/components',
+    openExternal: true
+  }, {
+    title: '@ims-view/hooks',
+    url: 'https://ims-view.site/hooks',
+    openExternal: true
+  }, {
+    title: '@ims-view/utils',
+    url: 'https://ims-view.site/utils',
+    openExternal: true
+  }, {
+    title: '@ims-view/chart',
+    url: 'https://ims-view.site/charts',
+    openExternal: true
+  }, {
+    title: 'ims-graph',
+    url: 'https://ims-graph.vercel.app/components/graph-chart',
+    openExternal: true
+  }, {
+    title: 'ims-indexed-db',
+    url: 'https://ims-indexed-db.vercel.app/',
+    openExternal: true
+  }, {
+    title: '@ims-view/components',
+    url: 'https://github.com/eternallycyf/components',
+    openExternal: true
+  }]
+}, {
+  title: '帮助',
+  items: [{
+    title: 'GitHub',
+    url: 'https://github.com/eternallycyf/ims-view-pc',
+    openExternal: true
+  }, {
+    title: '更新日志',
+    url: '/changelog/ims-view-pc'
+  }, {
+    title: '讨论',
+    url: 'https://github.com/eternallycyf/ims-view-pc/issues',
+    openExternal: true
+  }]
+}, {
+  title: '模板及配置',
+  items: [{
+    title: 'ims-monorepo-template',
+    description: 'monorepo模板',
+    url: 'https://github.com/eternallycyf/ims-monorepo-template',
+    openExternal: true
+  }, {
+    title: 'ims-template',
+    description: 'npm模板',
+    url: 'https://github.com/eternallycyf/ims-template',
+    openExternal: true
+  }, {
+    title: 'ims-template-config',
+    description: '配置',
+    url: 'https://github.com/eternallycyf/ims-template-config',
+    openExternal: true
+  }]
+}, {
+  title: '更多',
+  items: [{
+    title: 'lrxc-cli',
+    url: 'https://github.com/eternallycyf/lrxc-cli',
+    openExternal: true
+  }]
+}];

package/es/index.d.ts

@@ -0,0 +1,2 @@
+export { footer } from './components/footer';
+//# sourceMappingURL=index.d.ts.map

package/es/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC"}

package/es/index.js

@@ -0,0 +1 @@
+export { footer } from "./components/footer";

package/lib/components/footer/index.d.ts

@@ -0,0 +1,21 @@
+export declare const footer: ({
+    title: string;
+    items: ({
+        title: string;
+        url: string;
+        openExternal: boolean;
+    } | {
+        title: string;
+        url: string;
+        openExternal?: undefined;
+    })[];
+} | {
+    title: string;
+    items: {
+        title: string;
+        description: string;
+        url: string;
+        openExternal: boolean;
+    }[];
+})[];
+//# sourceMappingURL=index.d.ts.map

package/lib/components/footer/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/footer/index.tsx"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;IA6FlB,CAAC"}

package/lib/components/footer/index.js

@@ -0,0 +1,122 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/components/footer/index.tsx
+var footer_exports = {};
+__export(footer_exports, {
+  footer: () => footer
+});
+module.exports = __toCommonJS(footer_exports);
+var footer = [
+  {
+    title: "相关依赖",
+    items: [
+      {
+        title: "ims-view-pc",
+        url: "https://ims-view.site/components",
+        openExternal: true
+      },
+      {
+        title: "@ims-view/hooks",
+        url: "https://ims-view.site/hooks",
+        openExternal: true
+      },
+      {
+        title: "@ims-view/utils",
+        url: "https://ims-view.site/utils",
+        openExternal: true
+      },
+      {
+        title: "@ims-view/chart",
+        url: "https://ims-view.site/charts",
+        openExternal: true
+      },
+      {
+        title: "ims-graph",
+        url: "https://ims-graph.vercel.app/components/graph-chart",
+        openExternal: true
+      },
+      {
+        title: "ims-indexed-db",
+        url: "https://ims-indexed-db.vercel.app/",
+        openExternal: true
+      },
+      {
+        title: "@ims-view/components",
+        url: "https://github.com/eternallycyf/components",
+        openExternal: true
+      }
+    ]
+  },
+  {
+    title: "帮助",
+    items: [
+      {
+        title: "GitHub",
+        url: "https://github.com/eternallycyf/ims-view-pc",
+        openExternal: true
+      },
+      {
+        title: "更新日志",
+        url: "/changelog/ims-view-pc"
+      },
+      {
+        title: "讨论",
+        url: "https://github.com/eternallycyf/ims-view-pc/issues",
+        openExternal: true
+      }
+    ]
+  },
+  {
+    title: "模板及配置",
+    items: [
+      {
+        title: "ims-monorepo-template",
+        description: "monorepo模板",
+        url: "https://github.com/eternallycyf/ims-monorepo-template",
+        openExternal: true
+      },
+      {
+        title: "ims-template",
+        description: "npm模板",
+        url: "https://github.com/eternallycyf/ims-template",
+        openExternal: true
+      },
+      {
+        title: "ims-template-config",
+        description: "配置",
+        url: "https://github.com/eternallycyf/ims-template-config",
+        openExternal: true
+      }
+    ]
+  },
+  {
+    title: "更多",
+    items: [
+      {
+        title: "lrxc-cli",
+        url: "https://github.com/eternallycyf/lrxc-cli",
+        openExternal: true
+      }
+    ]
+  }
+];
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  footer
+});

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { footer } from './components/footer';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC"}

package/lib/index.js

@@ -0,0 +1,29 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.tsx
+var src_exports = {};
+__export(src_exports, {
+  footer: () => import_footer.footer
+});
+module.exports = __toCommonJS(src_exports);
+var import_footer = require("./components/footer");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  footer
+});

package/package.json

@@ -0,0 +1,112 @@
+{
+  "name": "ims-template-config",
+  "version": "1.0.0",
+  "description": "ims 一些配置",
+  "keywords": [
+    "config"
+  ],
+  "homepage": "https://github.com/eternallycyf/ims-template-config",
+  "bugs": {
+    "url": "https://github.com/eternallycyf/ims-template-config/issues/new"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eternallycyf/ims-template-config.git"
+  },
+  "license": "MIT",
+  "author": "eternallycyf(969475322@qq.com)",
+  "sideEffects": [
+    "**/*.less"
+  ],
+  "main": "lib/index.js",
+  "module": "es/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "es"
+  ],
+  "scripts": {
+    "build": "father build",
+    "build:watch": "father dev",
+    "changelog": "conventional-changelog -n node_modules/conventional-changelog-gitmoji-config/lib/index.js -i CHANGELOG.md -s -r 0",
+    "check-error": "npm run lint && npm run test && npm run test:coverage && npm run doctor",
+    "ci": "npm run lint && npm run type-check && npm run doctor && npm run build",
+    "clean": "rm -rf es lib dist coverage .dumi/tmp .eslintcache",
+    "dev": "dumi dev",
+    "docs:build": "dumi build",
+    "docs:preview": "yarn docs:build && cd dist && npx serve",
+    "doctor": "father doctor",
+    "lint": "eslint \"{src,test}/**/*.{js,jsx,ts,tsx}\"",
+    "prepare": "husky install && npm run setup",
+    "prepublishOnly": "npm run doctor && npm run build",
+    "prettier": "prettier -c --write \"**/**\"",
+    "release": "npm run ci && semantic-release",
+    "semantic-release": "semantic-release",
+    "setup": "dumi setup",
+    "start": "dumi dev",
+    "test": "vitest --passWithNoTests",
+    "test:coverage": "vitest run --coverage --passWithNoTests",
+    "test:update": "vitest -u",
+    "type-check": "tsc -p tsconfig-check.json"
+  },
+  "lint-staged": {
+    "*.{md,json}": [
+      "prettier --write --no-error-on-unmatched-pattern"
+    ],
+    "*.{js,jsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.{ts,tsx}": [
+      "eslint --fix",
+      "prettier --parser=typescript --write"
+    ]
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.23.1"
+  },
+  "devDependencies": {
+    "@ant-design/icons": "^5.2.6",
+    "@commitlint/cli": "^17",
+    "@testing-library/react": "^14",
+    "@types/lodash": "^4.14.199",
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
+    "@umijs/lint": "^4",
+    "@vitest/coverage-v8": "latest",
+    "antd": "^5.9.4",
+    "babel-plugin-antd-style": "^1.0.4",
+    "commitlint": "^17",
+    "commitlint-config-gitmoji": "^2",
+    "concurrently": "^7",
+    "conventional-changelog-gitmoji-config": "^1",
+    "cross-env": "^7",
+    "dumi": "^2",
+    "dumi-theme-antd-style": "^0.29.5",
+    "eslint": "^8",
+    "father": "^4",
+    "husky": "^8",
+    "jsdom": "^22",
+    "lint-staged": "^13",
+    "lodash": "^4.17.21",
+    "prettier": "^2",
+    "prettier-plugin-organize-imports": "^3",
+    "prettier-plugin-packagejson": "^2",
+    "react": "^18",
+    "react-dom": "^18",
+    "semantic-release": "^20",
+    "semantic-release-config-gitmoji": "^1",
+    "stylelint": "^15",
+    "typescript": "^5",
+    "vitest": "latest"
+  },
+  "peerDependencies": {
+    "@ant-design/icons": "^5.2.6",
+    "antd": "^5.9.4",
+    "lodash": "^4.17.21"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}