-
Notifications
You must be signed in to change notification settings - Fork 1
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.
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
NEW Migrate documentation linting to a new repository #1
NEW Migrate documentation linting to a new repository #1
Conversation
984984e
to
827234d
Compare
phpcs.xml
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is unaltered from the developer docs repo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ugh I really hate GitHub saying these are outdated. They're not! Show them in the files tab! Grr.
I wish we could manually mark comments as "not outdated"
[end rant]
package.json
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The dependencies in this file are unaltered from the developer docs repo
composer.json
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The dependencies in this file are unaltered from the developer docs repo
.markdownlint.yml
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is unaltered from the developer docs repo
.markdownlint-cli2.mjs
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is unaltered from the developer docs repo except for some minor styling tweaks and adding ignores
.eslintrc.js
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is unaltered from the developer docs repo except for the addition of rules.ignorePatterns
0bfcdbc
to
f5fcb38
Compare
f5fcb38
to
8e3b301
Compare
bin/ss-docs-lint
Outdated
cp "${DOCS_LINT_DIR}/package.json" package.json | ||
yarn install |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to avoid this, I really did, but the js linters just refused to lint anything that wasn't a child directory of the one with the package.json
file.
8e3b301
to
6a4fe85
Compare
6a4fe85
to
0526531
Compare
bin/ss-docs-lint
Outdated
# otherwise the linting tools will refuse to lint for us. | ||
if [[ $WITH_MD == 1 || $WITH_JS == 1 ]]; then | ||
cp "${DOCS_LINT_DIR}/package.json" package.json | ||
yarn install --network-concurrency 1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--network-concurrency 1
mirrors what's done for the js CI run - this is 90% of the time gonna be run in CI so lets reduce the chance of it throwing errors in our face.
bin/ss-docs-lint
Outdated
@@ -0,0 +1,197 @@ | |||
#!/usr/bin/env bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rename to bin/doclint
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, though I don't like it.
0526531
to
ef08613
Compare
ef08613
to
05093af
Compare
Issue