Skip to content

Project misconfigures eslint, prettier, & typedoc #606

@LJNeon

Description

@LJNeon

This is on the master branch (currently f4693f8).

  1. Eslint doesn't recognize the configuration in package.json:
Output of "npm run eslint"
$ npm run eslint         

> chrono-node@2.8.3 eslint
> eslint src test


Oops! Something went wrong! :(

ESLint: 9.27.0

ESLint couldnt find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.
  1. Prettier doesn't recognize the --loglevel option anymore, replacing it with --log-level:
Output of "npm run prettier"
$ npm run prettier

> chrono-node@2.8.3 prettier
> npm run prettier:src && npm run prettier:test


> chrono-node@2.8.3 prettier:src
> prettier --write src --loglevel=warn

[warn] Ignored unknown option --loglevel=warn. Did you mean --log-level?
# ...

> chrono-node@2.8.3 prettier:test
> prettier --write test --loglevel=warn

[warn] Ignored unknown option --loglevel=warn. Did you mean --log-level?
# ...
  1. Typedoc emits fifteen warnings, some about not recognizing @Link (should be @link) and others about references to non-documented classes.
Output of "npm run document"
$ npm run document 

> chrono-node@2.8.3 document
> typedoc

./src/chrono.ts:21:43 - [warning] Encountered an unknown inline tag @Link

21     * The parser implementation must provide {@Link pattern | pattern()} for the date format.

./src/chrono.ts:23:8 - [warning] Encountered an unknown inline tag @Link

23     * The {@Link extract | extract()} method is called with the patterns *match*.

./src/chrono.ts:70:31 - [warning] Encountered an unknown inline tag @Link

70         * A shortcut for calling {@Link parse | parse() } then transform the result into Javascripts Date object

./src/locales/ru/index.ts:55:30 - [warning] Encountered an unknown inline tag @Link

55     * Create a default *casual* {@Link Configuration} for Russian chrono.

./src/locales/ru/index.ts:56:13 - [warning] Encountered an unknown inline tag @Link

56     * It calls {@Link createConfiguration} and includes additional parsers.

./src/locales/ru/index.ts:69:21 - [warning] Encountered an unknown inline tag @Link

69     * Create a default {@Link Configuration} for Russian chrono

./src/locales/uk/index.ts:42:30 - [warning] Encountered an unknown inline tag @Link

42     * Create a default *casual* {@Link Configuration} for Ukrainian chrono.

./src/locales/uk/index.ts:43:13 - [warning] Encountered an unknown inline tag @Link

43     * It calls {@Link createConfiguration} and includes additional parsers.

./src/locales/uk/index.ts:56:21 - [warning] Encountered an unknown inline tag @Link

56     * Create a default {@Link Configuration} for Ukrainian chrono

[warning] DebugHandler, defined in chrono-node/src/debugging.ts, is referenced by ParsingContext but not included in the documentation
[warning] default, defined in chrono-node/src/locales/en/configuration.ts, is referenced by en.configuration but not included in the documentation
[warning] TimezoneAbbrMap, defined in chrono-node/src/types.ts, is referenced by ParsingOption.timezones but not included in the documentation
[warning] Configuration, defined in chrono-node/src/chrono.ts, is referenced by de.createCasualConfiguration but not included in the documentation
[warning] Duration, defined in chrono-node/src/calculation/duration.ts, is referenced by ParsingComponents.createRelativeFromReference.duration but not included in the documentation
[warning] AsyncDebugBlock, defined in chrono-node/src/debugging.ts, is referenced by ParsingContext.debug.block but not included in the documentation
[info] html generated at ./docs
[warning] Found 0 errors and 15 warnings

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions