Skip to content
This repository was archived by the owner on Aug 2, 2025. It is now read-only.

Update README.md#18

Merged
mit-mit merged 5 commits into
mainfrom
mit-mit-patch-1
May 11, 2021
Merged

Update README.md#18
mit-mit merged 5 commits into
mainfrom
mit-mit-patch-1

Conversation

@mit-mit

@mit-mit mit-mit commented May 11, 2021

Copy link
Copy Markdown
Contributor

@mit-mit mit-mit requested review from devoncarew, munificent and pq May 11, 2021 11:33
@mit-mit mit-mit mentioned this pull request May 11, 2021
Closed
pq
pq reviewed May 11, 2021
View reviewed changes
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
## How these lints are used

When creating new Dart project using the [`dart create`][dart create] command,
the 'recommended' set of lints are enabled by default.

@pq pq May 11, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fyi @devoncarew; I think the template currently is using core? (https://dart-review.googlesource.com/c/sdk/+/198620)

@pq pq May 11, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we change this to core or update the template?

/cc @devoncarew @mit-mit

@devoncarew devoncarew May 11, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch - this is not in sync w/ what dart create does. I believe that it was decided to use core - what pub scores with - but was not in that particular conversation.

@goderbauer goderbauer May 11, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My vote is for updating dart create to push people towards the recommended set. There are a lot of good lints in there. It would also align a little closer with flutter since flutter_lints builds on top of recommended.

@mit-mit mit-mit May 11, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep that as a separete issue; no need to block this readme update on that. I've made the text here more general.

I'll share a doc with some analysis for making the choice regarding dart create.

@mit-mit mit-mit May 11, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tracking issue: https://github.com/dart-lang/lints/issues/20

Comment thread README.md Outdated
Comment thread README.md Outdated
@devoncarew

devoncarew commented May 11, 2021 •
edited by pq
Loading

Copy link
Copy Markdown
Contributor

In this readme, we should also include the fact that you need to add a dev. dependency on lints to your pubspec (w/ a small sample snippet) and a sample of a simple analysis_options file. Perhaps in a 'how to use' section?

## How to use

Add a dev dependency on this package to your `pubspec.yaml` file:

``yaml
dev_dependencies:
  lints: ^1.0.0
``

And create a new `analysis_options.yaml` file, next to the pubspec, that includes the lints package:

``yaml
include: package:lints/core.yaml
``

pq
pq reviewed May 11, 2021
View reviewed changes
Comment thread README.md Outdated
@mit-mit

mit-mit commented May 11, 2021

Copy link
Copy Markdown
Contributor Author

In this readme, we should also include the fact that you need to add a dev. dependency on lints to your pubspec (w/ a small sample snippet) and a sample of a simple analysis_options file. Perhaps in a 'how to use' section?

Good idea; added

devoncarew
devoncarew approved these changes May 11, 2021
View reviewed changes

@devoncarew devoncarew left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm modulo reconciling the the item that Phil found; we should update this readme or the behavior of dart create.

Comment thread README.md Outdated
## How these lints are used

When creating new Dart project using the [`dart create`][dart create] command,
the 'recommended' set of lints are enabled by default.

@devoncarew devoncarew May 11, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch - this is not in sync w/ what dart create does. I believe that it was decided to use core - what pub scores with - but was not in that particular conversation.

@goderbauer goderbauer mentioned this pull request May 11, 2021
Closed
@mit-mit mit-mit merged commit 75244f5 into main May 11, 2021
@mit-mit mit-mit deleted the mit-mit-patch-1 branch May 11, 2021 20:06
mosuem pushed a commit to dart-lang/core that referenced this pull request Oct 18, 2024
@mit-mit
Update README.md (dart-archive/lints#18)
735b895
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@munificent munificent Awaiting requested review from munificent
3 more reviewers
@pq pq pq left review comments
@goderbauer goderbauer goderbauer left review comments
@devoncarew devoncarew devoncarew approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

add more documentation to the readme

4 participants

@mit-mit @devoncarew @pq @goderbauer