Skip to content

Add eslint-plugin-jsdoc #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,6 @@ I update dependencies regularly. These are the steps:
1. **Add type checking with TypeScript?** Yes, using JavaScript with JSDoc comments.
1. Add ESLint, Prettier and Vitest.
1. Revert `README.md`.
1. Run `pnpm i -D eslint-plugin-jsdoc`.
1. Check changes in `eslint.config.js` and manually revert preserving `eslint-plugin-jsdoc`.
1. Delete folder `node_modules` and file `pnpm-lock.yaml` and run `pnpm i`.
4 changes: 3 additions & 1 deletion eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import js from '@eslint/js';
import svelte from 'eslint-plugin-svelte';
import prettier from 'eslint-config-prettier';
import jsdoc from 'eslint-plugin-jsdoc';
import svelte from 'eslint-plugin-svelte';
import globals from 'globals';

/** @type {import('eslint').Linter.FlatConfig[]} */
Expand All @@ -9,6 +10,7 @@ export default [
...svelte.configs['flat/recommended'],
prettier,
...svelte.configs['flat/prettier'],
jsdoc.configs['flat/recommended'],
{
languageOptions: {
globals: {
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
"@types/eslint": "^8.56.7",
"eslint": "^9.0.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-jsdoc": "^48.5.0",
"eslint-plugin-svelte": "^2.36.0",
"globals": "^15.0.0",
"prettier": "^3.1.1",
Expand Down
114 changes: 114 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.