Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update CLI documentation for ng lint with eslint #19638

Closed
Cephyric-gh opened this issue Dec 16, 2020 · 3 comments · Fixed by #19649, TypescriptID/angular-cli#510, GulajavaMinistudio/angular-cli#336 or angular-indonesia/angular-cli#535
Closed

Update CLI documentation for ng lint with eslint #19638

Cephyric-gh opened this issue Dec 16, 2020 · 3 comments · Fixed by #19649, TypescriptID/angular-cli#510, GulajavaMinistudio/angular-cli#336 or angular-indonesia/angular-cli#535
Labels
area: docs Related to the documentation

Comments

@Cephyric-gh
Copy link

📚 Docs or angular.io bug report

Description

After migrating a project from TSLint to ESLint (as the CLI now recommends on the latest version if you run ng lint, the options for the command are now slightly different. The docs for this needs updating to reflect the changes, as personally it took me much longer than it should have to find out that after migrating, --files no longer exists, and --lint-file-patterns must be used in its place.

🔬 Minimal Reproduction

Set up a project & follow the migration steps from the angular-eslint package for migrating

Expected vs Actual Behavior**

Expected behavior:
The docs should either be changed to reflect the options available via ESLint, or the docs should have a new section for options when using ESLint

Actual Behavior:
The docs only show information for the command if you are using TSLint

🌍 Your Environment

MacOS High Sierra
Angular 11.0.3
Angular CLI 11.0.3
@petebacondarwin
Copy link
Member

The docs for ng command line options are stored in the CLI repository. Transferring...

@petebacondarwin petebacondarwin transferred this issue from angular/angular Dec 16, 2020
@alan-agius4
Copy link
Collaborator

ng lint is currently showing the options of the 1st party lint builder for TSlint. angular-eslint builder is a 3rd party solution and users can choose to either use that or another. Hence, in this case I think we should update the docs to be in similar to ng deploy

Let me mark this for further discussion with the reset of the team.

@alan-agius4 alan-agius4 added needs: discussion On the agenda for team meeting to determine next steps area: docs Related to the documentation labels Dec 16, 2020
@alan-agius4 alan-agius4 mentioned this issue Dec 18, 2020
Merged
alan-agius4 added a commit that referenced this issue Dec 19, 2020
@alan-agius4
docs: clarify that the options of ng lint in AIO are of the depreca…
efcec62 
…ted builder

Fix: #19638
alan-agius4 added a commit that referenced this issue Dec 19, 2020
@alan-agius4
docs: clarify that the options of ng lint in AIO are of the depreca…
342cea9 
…ted builder

Fix: #19638
(cherry picked from commit efcec62)
@alan-agius4 alan-agius4 removed the needs: discussion On the agenda for team meeting to determine next steps label Dec 19, 2020
This was referenced Dec 20, 2020
Merged
Merged
Merged
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Jan 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
area: docs Related to the documentation
Projects
None yet
Milestone
No milestone
3 participants
@petebacondarwin @Cephyric-gh @alan-agius4