Skip to content
This repository has been archived by the owner on Aug 7, 2023. It is now read-only.

Lint markdown files with mdast #16

Merged
merged 1 commit into from
Dec 21, 2015

Conversation

SpainTrain
Copy link
Member

  • Dogfood the linter by linting its own markdown files
  • Add linting to CI

Review on Reviewable

@@ -11,6 +11,8 @@ dependencies:
- atom -v
- apm -v
- apm install
# test:
test:
pre:
Copy link
Member

Choose a reason for hiding this comment

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

I would rather this was changed to:

test:
  override:
    - npm run lint
    - npm test

So that we are explicitly stating what we want tested instead of relying on Circle's inference behavior, but currently at least it makes no difference so it could go either way.

Copy link
Member Author

Choose a reason for hiding this comment

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

We've discussed a similar issue before. IMO it doesn't make sense to override with the default, it's just redundant. Also, I explicitly do want to lint before testing. Until there are specs and we truly do want to override default behavior with the atom plugin testing script, I feel like this is a sensible config...

Copy link
Member

Choose a reason for hiding this comment

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

Merge away then, just wanted to make sure it was thought about 😉.

Copy link
Member Author

Choose a reason for hiding this comment

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

over-thought X-D

@@ -4,6 +4,7 @@
"version": "1.2.3",
"description": "Lint markdown on the fly, using mdast-lint",
"scripts": {
"lint": "mdast -u mdast-lint README.md LICENSE.md",
Copy link
Member Author

Choose a reason for hiding this comment

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

Would have preferred wildcard, but changelog.md appears to be generated, so linting it would be a bit of a pain.

@SpainTrain
Copy link
Member Author

Shouldn't there be an actual copyright holder name here?

Sure, but I do not know who. @leipert ?

@keplersj
Copy link
Contributor

Probably, but you could just set the holder to the AtomLinter organization. Since both you and @leipert are members you would share the copyright. But you'd also be sharing it with everyone else in the organization.

* Dogfood the linter by linting its own markdown files
* Add linting to CI
@Arcanemagus
Copy link
Member

This LGTM other than the circle.yml comment above.

SpainTrain added a commit that referenced this pull request Dec 21, 2015
Lint markdown files with mdast
@SpainTrain SpainTrain merged commit a7ad009 into AtomLinter:master Dec 21, 2015
@SpainTrain SpainTrain deleted the lint-readme branch December 21, 2015 19:57
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants