Skip to content

Commit

Permalink
cleaned up jsdoc and added npm run jsdoc to convert into html docs (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
lGrom committed Jul 31, 2024
1 parent a4a7de9 commit 648aa78
Show file tree
Hide file tree
Showing 8 changed files with 582 additions and 105 deletions.
26 changes: 23 additions & 3 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,30 @@
module.exports = {
plugins: [
'jsdoc'
],
extends: [
'standard'
'standard',
'plugin:jsdoc/recommended'
],

rules: {
indent: ['error', 4],
semi: ['error', 'always']
semi: ['error', 'always'],
'jsdoc/check-alignment': 'error',
'jsdoc/check-param-names': 'error',
'jsdoc/check-tag-names': 'error',
'jsdoc/check-types': 'error',
'jsdoc/implements-on-classes': 'error',
'jsdoc/no-undefined-types': 'error',
'jsdoc/require-description': 'error',
'jsdoc/require-hyphen-before-param-description': 'error',
'jsdoc/require-param': 'error',
'jsdoc/require-param-description': 'error',
'jsdoc/require-param-name': 'error',
'jsdoc/require-param-type': 'error',
'jsdoc/require-returns': 'error',
'jsdoc/require-returns-check': 'error',
'jsdoc/require-returns-description': 'error',
'jsdoc/require-returns-type': 'error',
'jsdoc/no-defaults': 'off'
}
};
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

# production
/build
/docs

# misc
.DS_Store
Expand Down
17 changes: 17 additions & 0 deletions jsdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"source": {
"include": ["src"],
"includePattern": ".+\\.js(doc|x)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"opts": {
"destination": "./docs",
"recurse": true
},
"templates": {
"default": {
"includeDate": false
}
}
}

Loading

0 comments on commit 648aa78

Please sign in to comment.