refactor: json config structure #42
Conversation
excaliborr
changed the title
package.json
Outdated
| "@types/jest": "29.5.11", | ||
| "@types/node": "20.10.7", | ||
| "@typescript-eslint/parser": "6.2.0", | ||
| "ajv": "8.12.0", |
There was a problem hiding this comment.
Should these 2 packages be in the dependencies section?
src/types.ts
Outdated
| notice: Type.Boolean(), | ||
| return: Type.Boolean(), | ||
| }), | ||
| inheritdoc: Type.Optional(Type.Boolean()), |
There was a problem hiding this comment.
I believe the inheritdoc option will either replace enforceInheritdoc or be under functions as it does not make sense to have inheritdoc enabled for external functions but not for public, or have it for functions but not for variables. It's ok as it is for now though, we will get to it when reading / using the config.
src/utils.ts
Outdated
| root: detectedConfig.root ?? './', | ||
| functions: detectedConfig.functions, | ||
| enforceInheritdoc: detectedConfig.enforceInheritdoc ?? true, | ||
| constructorNatspec: detectedConfig.constructorNatspec ?? false, |
There was a problem hiding this comment.
A TODO for one of the next PRs: deprecation logic will be defined here
src/types.ts
Outdated
| notice: Type.Boolean(), | ||
| return: Type.Boolean(), |
There was a problem hiding this comment.
notice and return should be true by default
test/utils.test.ts
Outdated
| }); | ||
| }); | ||
|
|
||
| it('Should revert with an invalid config', async () => { |
There was a problem hiding this comment.
Lowercase to match the rest of the tests 😬
| it('Should revert with an invalid config', async () => { | |
| it('should revert with an invalid config', async () => { |
package.json
Outdated
| "@typescript-eslint/parser": "6.2.0", | ||
| "eslint": "8.56.0", | ||
| "eslint-plugin-jsdoc": "48.1.0", |
There was a problem hiding this comment.
Pls revert, these are useful packages
There was a problem hiding this comment.
how did this even happen lmao
🤖 Linear
Doesn't fully complete the linear task