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.

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

Merged

Conversation

GuySartorelli
Copy link
Member

@GuySartorelli GuySartorelli commented Apr 2, 2024

phpcs.xml Outdated
Copy link
Member Author

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

Copy link
Member Author

@GuySartorelli GuySartorelli Apr 3, 2024

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
Copy link
Member Author

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
Copy link
Member Author

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

Copy link
Member Author

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

Copy link
Member Author

@GuySartorelli GuySartorelli Apr 2, 2024

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
Copy link
Member Author

@GuySartorelli GuySartorelli Apr 2, 2024

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

bin/ss-docs-lint Outdated
Comment on lines 144 to 145
cp "${DOCS_LINT_DIR}/package.json" package.json
yarn install
Copy link
Member Author

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.

@GuySartorelli GuySartorelli marked this pull request as ready for review April 3, 2024 03:02
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
Copy link
Member Author

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
Copy link
Member

Choose a reason for hiding this comment

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

Rename to bin/doclint

Copy link
Member Author

@GuySartorelli GuySartorelli Apr 4, 2024

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.

@emteknetnz emteknetnz merged commit 9fb4e41 into silverstripe:1 Apr 4, 2024
@emteknetnz emteknetnz deleted the pulls/1/migrate-to-repo branch April 4, 2024 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants