{"_id":"@agds/eslint-config-jsdoc","name":"@agds/eslint-config-jsdoc","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@agds/eslint-config-jsdoc","version":"1.0.0","description":"agds的jsdoc eslint配置，推荐lib项目使用此规则","keywords":["eslint","agds","config","jsdoc"],"repository":{"type":"git","url":"https://gitee.com/agile-development-system/eslint-config-jsdoc.git"},"license":"MIT","author":{"name":"junyang"},"main":"lib/index.js","scripts":{"changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 0","postchangelog":"git add . && git commit -m \"docs(changelog): 更新CHANGELOG\" || true","commit":"git add . && git commit --no-edit","docs":"agds-doc","lint":"eslint --ext .js,.json,.md lib","lint:fix":"eslint --ext .js,.json,.md lib --fix","prepublishOnly":"npm run docs && (git add . && git commit -m \"docs(readme): 更新文档\" || true)","postversion":"npm run changelog"},"lint-staged":{"**/*.{js,json,md}":["eslint --fix"]},"dependencies":{"eslint-plugin-jsdoc":"^35.0.0"},"devDependencies":{"@agds/agds-doc-preset":"^1.0.6","@agds/cli-plugin-doc":"^1.0.10","@agds/eslint-config-js":"^1.0.7","@commitlint/cli":"^12.1.4","@commitlint/config-conventional":"^12.1.4","commitizen":"^4.2.4","conventional-changelog":"^3.1.24","conventional-changelog-cli":"^2.1.1","cz-conventional-changelog-zh":"^0.0.2","lint-staged":"^11.0.0","yorkie":"^2.0.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"gitHooks":{"pre-commit":"lint-staged","commit-msg":"commitlint -e $GIT_PARAMS","prepare-commit-msg":"agds-gc-has-msg && exec < /dev/tty && git cz --hook || true"},"gitHead":"63756ee34ca18c245be1c1bfd9cbd6b0c557b0d3","_id":"@agds/eslint-config-jsdoc@1.0.0","_nodeVersion":"16.14.2","_npmVersion":"8.5.0","dist":{"integrity":"sha512-njxZPCPnXTw4HDHr56hePZua8XW8j/KO3Gwuw3MEwxnk5pwOCxfBqjRAYbf3HJBRDBltvN2/otjK7Sdg75DHIQ==","shasum":"9b312831b39f5ee44d7219a2abe8df054a834743","tarball":"https://registry.npmjs.org/@agds/eslint-config-jsdoc/-/eslint-config-jsdoc-1.0.0.tgz","fileCount":4,"unpackedSize":5639,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIE7yHVlOgf6HDP1R753GWGYCJeYyurORHIKpSMhMpdOuAiApI4GwPsF29oiDipNtBi5eI4DfmEFULTC0ik0ZdkX5NA=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJip/8pACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpl+w/9Fkw2OhBPM2lb3YhZOavXdmx63bKc9uX86dYilboQHE4MIOcm\r\nso5gDupygLAaorOPxpdMMnWUG7wKHOhV8L4rx6MariaryuIhAfCOBsw1mJJY\r\nI5Wkf9GraLPGC/R3OscTNy7zAacBzl97nFPes044+pOt+PXHAF1KBDrUcYe6\r\nlAQVO8bZmf6P1TekzpMEJenRS82NAtLhcj9XbhfoGmg6GCwYrtadXNzQajyX\r\ntAhwmtwdgXj31XFBqSE4J1GJygXK2CtiDBmBJxXP62XYnuRR0VNBhJ3oKPl6\r\nCJm1RdU1aN8zStbjfYFYxYWYK3tQHneXmr757XE24tYuNkBGTNsywkRKX6aP\r\nQRKqIsZkTuMxeHgPbP+d5OluYoJCO0HA0kio2kVT7TuvIBH/ld7N3QcBMPYJ\r\nRCJzrROtPenWudFOHW4zMIFRpopkQBOTNUZOE6mw9GiAxcL0IiiihVViJqCt\r\ngzFu4TpsgPpr5c9yERc3+waasYa2vC3humtnUVLvisY34bkM1VlmY8TCcqoR\r\nFDbultWyXDNSabBxsTbf94+g9MtWjZlsuCohzrFtCbyQggAaoflv3O2mGRYo\r\nrSvsMogTd1e6Fy5+PaFei679+Wt6eKU/H++ZRsDqYIN3Trt9QQUZB0aGP4vZ\r\nOG4vI1U5UmwEuRFf30+9V3YnUVdn3nZFcUw=\r\n=5ADb\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"chujunyang","email":"961284688@qq.com"},"directories":{},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/eslint-config-jsdoc_1.0.0_1655177001475_0.48502116372231385"},"_hasShrinkwrap":false}},"time":{"created":"2022-06-14T03:23:21.378Z","1.0.0":"2022-06-14T03:23:21.722Z","modified":"2022-06-14T03:23:21.853Z"},"maintainers":[{"name":"chujunyang","email":"961284688@qq.com"}],"description":"agds的jsdoc eslint配置，推荐lib项目使用此规则","keywords":["eslint","agds","config","jsdoc"],"repository":{"type":"git","url":"https://gitee.com/agile-development-system/eslint-config-jsdoc.git"},"author":{"name":"junyang"},"license":"MIT","readme":"<p align=\"center\">\n    <img src=\"https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/logos/light/1.png\" alt=\"logo\">\n</p>\n\n# @agds/eslint-config-jsdoc\n\n**版本** ：1.0.0\n\nagds的jsdoc eslint配置，推荐lib项目使用此规则\n\n## 快速开始\n\n### 安装\n\n```bash\nnpm i -D @agds/eslint-config-jsdoc\n```\n\n### 引入\n\n```js\n// .eslintrc.js\nmodule.exports = {\n    extends: [\n        '@agds/jsdoc',\n    ],\n};\n```\n\n\n### 添加lint脚本\n\n在`package.json`的`scripts`下添加lint命令；\n\n```json\n{\n  \"scripts\": {\n    \"lint\": \"eslint --ext .js,.json,.md src\",\n    \"lint:fix\": \"eslint --ext .js,.json,.md src --fix\"\n  }\n}\n```\n\n### 基于`lint-staged`提供增量lint脚本\n\n- 安装`lint-staged`包\n    ```\n    npm i -D lint-staged\n    ```\n- 在`package.json`中添加`pkg['lint-staged']`脚本\n    ```json\n    {\n      \"lint-staged\": {\n        \"src/**/*.{js,json,md}\": [\n          \"eslint --fix\"\n        ]\n      }\n    }\n    ```\n\n### 使用`yorkie`在git声明周期内检测代码格式\n\n- 安装`yorkie`包\n    ```\n    npm i -D yorkie\n    ```\n- 在`package.json`中添加`pkg.gitHooks`脚本\n    ```json\n    {\n      \"gitHooks\": {\n        \"pre-commit\": \"lint-staged\"\n      }\n    }\n    ```\n\n\n<a name=\"source\"></a>\n\n## 配置源码\n\n```js\nmodule.exports = {\n    extends: [\n        'plugin:jsdoc/recommended',\n    ],\n    plugins: [\n        'jsdoc',\n    ],\n    settings: {\n        jsdoc: {\n            mode: 'typescript',\n        },\n    },\n    rules: {\n        // jsdoc\n        'valid-jsdoc': 'off',\n        'jsdoc/require-property': 0,\n        'jsdoc/require-returns-description': 0,\n        'jsdoc/no-undefined-types': 0,\n    },\n};\n\n```\n\n\n<a name=\"license\"></a>\n\n## 许可证\n\n[MIT License](https://gitee.com/agile-development-system/eslint-config-jsdoc/blob/master/LICENSE)\nCopyright (c) 2021 锦阳\n\n<a name=\"donate\"></a>\n\n## 请维护者喝杯咖啡\n\n<div style=\"display:flex;\">\n<img src=\"https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/qrcode/alipay.jpeg\" width=\"209px\" >\n<img src=\"https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/qrcode/wechatpay.jpeg\" width=\"237px\" >\n</div>\n\n<a name=\"dingtalk\"></a>\n\n## 加入钉钉群讨论或加入开发\n\n<img src=\"https://gitee.com/agile-development-system/agds-doc-preset/raw/master/lib/docs/qrcode/dingtalk.jpeg\" width=\"188px\" >\n\n","readmeFilename":"README.md"}