diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 1e73f6c..af717f0 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,6 +1,6 @@ -> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md) before filling out this issue template**. +> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md) before filling out this issue template**. ## [Please follow one of the issue templates](https://github.com/arcticicestudio/styleguide-javascript/issues/new/choose) diff --git a/.github/ISSUE_TEMPLATE/bugs.md b/.github/ISSUE_TEMPLATE/bugs.md index 40ccf68..3e84e8f 100644 --- a/.github/ISSUE_TEMPLATE/bugs.md +++ b/.github/ISSUE_TEMPLATE/bugs.md @@ -5,7 +5,7 @@ about: Report a bug that is caused by the code in this repository -> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md) before filling out this issue template**. +> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md) before filling out this issue template**. ## Prerequisites @@ -14,7 +14,7 @@ This section and the instructions in the sections below are only part of this is Please do your best to provide as much information as possible and use a clear and descriptive title for your bug report to help maintainers and the community understand and reproduce the behavior, find related reports and to resolve the ticket faster. - **Ensure the bug has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/styleguide-javascript/issues)** — check if this enhancement has already been suggested. If it has **and the issue is still open**, add your additions as comment to the existing issue instead of opening a new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue. -- **Ensure the bug is reproducible and has not already been fixed** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`develop`](https://github.com/arcticicestudio/styleguide-javascript/tree/develop) branch. +- **Ensure the bug is reproducible and has not already been fixed** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`master`](https://github.com/arcticicestudio/styleguide-javascript/tree/master) branch. ## Metadata Head @@ -42,7 +42,7 @@ What actually happens? ## Example -Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/main/CONTRIBUTING.md#mcve) +Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#mcve) **This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the bug.** The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) into this issue. diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md index 25767f2..6878902 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -5,7 +5,7 @@ about: Submit an enhancement suggestion for new features or minor improvements t -> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md) before filling out this issue template**. +> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md) before filling out this issue template**. ## Prerequisites @@ -14,7 +14,7 @@ This section and the instructions in the sections below are only part of this is Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion to help maintainers and the community understand and reproduce the behavior, find related reports and to resolve the ticket faster. - **Ensure the enhancement has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/styleguide-javascript/issues)** — check if this enhancement has already been suggested. If it has **and the issue is still open**, add your additions as comment to the existing issue instead of opening a new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue. -- **Check if the enhancement has already been implemented** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`develop`](https://github.com/arcticicestudio/styleguide-javascript/tree/develop) branch to ensure that the feature or improvement has not already been added. +- **Check if the enhancement has already been implemented** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`master`](https://github.com/arcticicestudio/styleguide-javascript/tree/master) branch to ensure that the feature or improvement has not already been added. ## Metadata Head @@ -40,7 +40,7 @@ If you've considered alternative features or solutions please describe it clearl ## Example -Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#mcve) +Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#mcve) **This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the enhancement.** The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) into this issue. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f7d37a1..7876aca 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ -> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md) before filling out this pull request template**. +> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md) before filling out this pull request template**. ## Prerequisites @@ -9,8 +9,8 @@ This section and the instructions in the sections below are only part of this pu Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion or bug fix to help maintainers and the community understand and reproduce the behavior, find related pull requests and to merge it faster. - **Ensure the pull request has not already been submitted by using the [GitHub Pull Request search](https://github.com/arcticicestudio/styleguide-javascript/pulls)** — check if this enhancement or bug fix has already been suggested. If it has **and the pull request is still open**, add your additions as comment or [suggest a change](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request#applying-a-suggested-change) to the existing pull request instead of opening a new one. If you find a closed pull request that seems to be similar to this one, include a link to the original pull request in the [metadata head](#metadata-head) section of this new pull request. -- **Ensure to adhere to the [pull request contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#pull-requests)**, especially the one for tests and documentations. -- **Check if the enhancement has already been implemented or bug already fixed** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`develop`](https://github.com/arcticicestudio/styleguide-javascript/tree/develop) branch to ensure that the enhancement or bug fix has not already been added. +- **Ensure to adhere to the [pull request contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#pull-requests)**, especially the one for tests and documentations. +- **Check if the enhancement has already been implemented or bug already fixed** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`master`](https://github.com/arcticicestudio/styleguide-javascript/tree/master) branch to ensure that the enhancement or bug fix has not already been added. ## Metadata Head diff --git a/.remarkrc.js b/.remarkrc.js index 1bc5665..deddb26 100644 --- a/.remarkrc.js +++ b/.remarkrc.js @@ -11,7 +11,7 @@ */ module.exports = { plugins: [ - "@arcticicestudio/remark-preset-lint", + "remark-preset-lint-arcticicestudio", /* Disabled to suppress warnings about duplicate "Example" headings. */ ["remark-lint-no-duplicate-headings", false], ], diff --git a/CHANGELOG.md b/CHANGELOG.md index 48b088a..334448c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -
Copyright © 2018-present Arctic Ice Studio and Sven Greb
- + @@ -170,17 +170,17 @@ Every significant change is documented in the [changelog][gh-changelog]. Thanks for the inspirations and attributions to GitHub's [Open Source Guides][os-guide] and various contribution guides of large open source projects like [Atom][gh-atom-contrib], [React][react-contrib] and [Ruby on Rails][ruby-on-rails-contrib]. [gh-atom-contrib]: https://github.com/atom/atom/blob/master/CONTRIBUTING.md -[gh-branch-main]: https://github.com/arcticicestudio/styleguide-javascript/tree/main -[gh-changelog]: https://github.com/arcticicestudio/styleguide-javascript/blob/main/CHANGELOG.md -[gh-coc]: https://github.com/arcticicestudio/styleguide-javascript/blob/main/CODE_OF_CONDUCT.md +[gh-branch-master]: https://github.com/arcticicestudio/styleguide-javascript/tree/master +[gh-changelog]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CHANGELOG.md +[gh-coc]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CODE_OF_CONDUCT.md [gh-gist]: https://gist.github.com [gh-issues-label-question]: https://github.com/arcticicestudio/styleguide-javascript/labels/type-question -[gh-issues-template-bug]: https://github.com/arcticicestudio/styleguide-javascript/blob/main/.github/ISSUE_TEMPLATE/bugs.md -[gh-issues-template-enhancement]: https://github.com/arcticicestudio/styleguide-javascript/blob/main/.github/ISSUE_TEMPLATE/enhancement.md -[gh-issues-template-pr]: https://github.com/arcticicestudio/styleguide-javascript/blob/main/.github/PULL_REQUEST_TEMPLATE.md +[gh-issues-template-bug]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/.github/ISSUE_TEMPLATE/bugs.md +[gh-issues-template-enhancement]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/.github/ISSUE_TEMPLATE/enhancement.md +[gh-issues-template-pr]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/.github/PULL_REQUEST_TEMPLATE.md [gh-issues-templates]: https://github.com/arcticicestudio/styleguide-javascript/issues/new/choose [gh-issues]: https://github.com/arcticicestudio/styleguide-javascript/issues -[gh-mailmap]: https://github.com/arcticicestudio/styleguide-javascript/blob/main/.mailmap +[gh-mailmap]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/.mailmap [gh-pr]: https://github.com/arcticicestudio/styleguide-javascript/pulls [gh-releases-latest]: https://github.com/arcticicestudio/styleguide-javascript/releases/latest [gh-styleguide-git]: https://github.com/arcticicestudio/styleguide-git diff --git a/README.md b/README.md index 4058912..fd24fa2 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -The Arctic Ice Studio JavaScript code style based on the Airbnb JavaScript Style Guide.
- + @@ -28,11 +28,11 @@ Read the [contributing guide][gh-b-contrib] to learn about the development proce The guide also includes information about [minimal, complete, and verifiable examples][gh-b-contrib#mcve] and other ways to contribute to the project like [improving existing issues][gh-b-contrib#help_issues] and [giving feedback on issues and pull requests][gh-b-contrib#help_fb]. -Copyright © 2018-present Arctic Ice Studio and Sven Greb
- + [docs-r-ecma6]: https://arcticicestudio.github.io/styleguide-javascript/rules/ecmascript_6+_styles.html [docs-r-react-order#meth_props]: https://arcticicestudio.github.io/styleguide-javascript/rules/react/ordering.html#component-methods-and-properties @@ -42,19 +42,19 @@ The guide also includes information about [minimal, complete, and verifiable exa [docs-rules-react-hoc]: https://arcticicestudio.github.io/styleguide-javascript/rules/react/higher_order_components.html [docs]: https://arcticicestudio.github.io/styleguide-javascript [eslint]: https://eslint.org -[gh-b-contrib]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md -[gh-b-contrib#bug]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#bug-reports -[gh-b-contrib#enhance]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#enhancement-suggestions -[gh-b-contrib#help_fb]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#give-feedback-on-issues-and-pull-requests -[gh-b-contrib#help_issues]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#improve-issues -[gh-b-contrib#mcve]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#mcve -[gh-b-contrib#pr]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#pull-requests -[gh-b-contrib#stgs]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#style-guides -[gh-b-contrib#vcs]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#branch-organization -[gh-b-contrib#ver]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#versioning -[gh-t-pkg-esl-conf-base]: https://github.com/arcticicestudio/styleguide-javascript/tree/develop/packages/@arcticicestudio/eslint-config-base -[gh-t-pkg-esl-conf]: https://github.com/arcticicestudio/styleguide-javascript/tree/develop/packages/@arcticicestudio/eslint-config -[gh-t-pkg-esl-ts]: https://github.com/arcticicestudio/styleguide-javascript/tree/develop/packages/@arcticicestudio/eslint-config-typescript +[gh-b-contrib]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md +[gh-b-contrib#bug]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#bug-reports +[gh-b-contrib#enhance]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#enhancement-suggestions +[gh-b-contrib#help_fb]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#give-feedback-on-issues-and-pull-requests +[gh-b-contrib#help_issues]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#improve-issues +[gh-b-contrib#mcve]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#mcve +[gh-b-contrib#pr]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#pull-requests +[gh-b-contrib#stgs]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#style-guides +[gh-b-contrib#vcs]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#branch-organization +[gh-b-contrib#ver]: https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#versioning +[gh-t-pkg-esl-conf-base]: https://github.com/arcticicestudio/styleguide-javascript/tree/master/packages/@arcticicestudio/eslint-config-base +[gh-t-pkg-esl-conf]: https://github.com/arcticicestudio/styleguide-javascript/tree/master/packages/@arcticicestudio/eslint-config +[gh-t-pkg-esl-ts]: https://github.com/arcticicestudio/styleguide-javascript/tree/master/packages/@arcticicestudio/eslint-config-typescript [npm-eslint-plugin-jsx-a11y]: https://www.npmjs.com/package/eslint-plugin-jsx-a11y [prettier]: https://prettier.io [react]: https://reactjs.org diff --git a/package.json b/package.json index 423a848..aeb9a02 100644 --- a/package.json +++ b/package.json @@ -39,7 +39,7 @@ "format:pretty": "prettier --write .", "lint": "npm-run-all lint:*", "lint:js": "eslint .", - "lint:md": "remark --no-stdout . \".github/**/*.md\"", + "lint:md": "remark --no-stdout . .github/**/*.md", "lint:pretty": "prettier --check .", "prepare": "run-s prepare:*", "prepare:husky": "husky install", diff --git a/packages/@arcticicestudio/eslint-config-base/README.md b/packages/@arcticicestudio/eslint-config-base/README.md index e503b1a..fb6a499 100644 --- a/packages/@arcticicestudio/eslint-config-base/README.md +++ b/packages/@arcticicestudio/eslint-config-base/README.md @@ -1,8 +1,8 @@ -The Arctic Ice Studio JavaScript Style Guide base rules as an extensible shared ESLint configuration.
- + @@ -118,11 +118,11 @@ This package provides multiple entry points that can be composed especially for Please read the [contribution guidelines][gh-stg-b-readme#contrib] of the [Arctic Ice Studio JavaScript style guide][gh-stg-repo] project for detailed information. -Copyright © 2018-present Arctic Ice Studio and Sven Greb
- + [esl-docs-conf_share]: https://eslint.org/docs/developer-guide/shareable-configs [esl-docs-config#ext_conf]: https://eslint.org/docs/user-guide/configuring#extending-configuration-files @@ -139,7 +139,7 @@ Please read the [contribution guidelines][gh-stg-b-readme#contrib] of the [Arcti [gh-remarkjs/remark-lint]: https://github.com/remarkjs/remark-lint [gh-stg-b-readme#contrib]: https://github.com/arcticicestudio/styleguide-javascript#contributing [gh-stg-repo]: https://github.com/arcticicestudio/styleguide-javascript -[gh-t-pkg-esl]: https://github.com/arcticicestudio/styleguide-javascript/tree/develop/packages/@arcticicestudio/eslint-config +[gh-t-pkg-esl]: https://github.com/arcticicestudio/styleguide-javascript/tree/master/packages/@arcticicestudio/eslint-config [mdn-js-export]: https://developer.mozilla.org/en-US/docs/web/javascript/reference/statements/export [mdn-js-import]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import [node-blog-peer_deps]: https://nodejs.org/en/blog/npm/peer-dependencies diff --git a/packages/@arcticicestudio/eslint-config-typescript/README.md b/packages/@arcticicestudio/eslint-config-typescript/README.md index 7c43ff9..29b6cac 100644 --- a/packages/@arcticicestudio/eslint-config-typescript/README.md +++ b/packages/@arcticicestudio/eslint-config-typescript/README.md @@ -1,8 +1,8 @@ -The Arctic Ice Studio JavaScript style guide rules with support for TypeScript as an extensible ESLint configuration.
- + @@ -144,11 +144,11 @@ This package provides multiple entry points that can be composed especially for Please read the [contribution guidelines][gh-stg-b-readme#contrib] of the [Arctic Ice Studio JavaScript style guide][gh-stg-repo] project for detailed information. -Copyright © 2018-present Arctic Ice Studio and Sven Greb
- + [esl-d-conf_share]: https://eslint.org/docs/developer-guide/shareable-configs [esl-d-config#ext_conf]: https://eslint.org/docs/user-guide/configuring#extending-configuration-files @@ -169,8 +169,8 @@ Please read the [contribution guidelines][gh-stg-b-readme#contrib] of the [Arcti [gh-remarkjs/remark-lint]: https://github.com/remarkjs/remark-lint [gh-stg-b-readme#contrib]: https://github.com/arcticicestudio/styleguide-javascript#contributing [gh-stg-repo]: https://github.com/arcticicestudio/styleguide-javascript -[gh-t-pkg-esl-base]: https://github.com/arcticicestudio/styleguide-javascript/tree/develop/packages/@arcticicestudio/eslint-config-base -[gh-t-pkg-esl]: https://github.com/arcticicestudio/styleguide-javascript/tree/develop/packages/@arcticicestudio/eslint-config +[gh-t-pkg-esl-base]: https://github.com/arcticicestudio/styleguide-javascript/tree/master/packages/@arcticicestudio/eslint-config-base +[gh-t-pkg-esl]: https://github.com/arcticicestudio/styleguide-javascript/tree/master/packages/@arcticicestudio/eslint-config [gh-ts]: https://github.com/microsoft/TypeScript [node-blog-peer_deps]: https://nodejs.org/en/blog/npm/peer-dependencies [node-dist-index]: https://nodejs.org/dist/index.json diff --git a/packages/@arcticicestudio/eslint-config/README.md b/packages/@arcticicestudio/eslint-config/README.md index 5cf3b81..3018bea 100644 --- a/packages/@arcticicestudio/eslint-config/README.md +++ b/packages/@arcticicestudio/eslint-config/README.md @@ -1,8 +1,8 @@ -The Arctic Ice Studio JavaScript Style Guide rules with support for React as an extensible ESLint configuration.
- + @@ -116,11 +116,11 @@ This package provides multiple entry points that can be composed especially for Please read the [contribution guidelines][gh-stg-b-readme#contrib] of the [Arctic Ice Studio JavaScript style guide][gh-stg-repo] project for detailed information. -Copyright © 2018-present Arctic Ice Studio and Sven Greb
- + [esl-d-conf_share]: https://eslint.org/docs/developer-guide/shareable-configs [esl-d-config#ext_conf]: https://eslint.org/docs/user-guide/configuring#extending-configuration-files @@ -134,7 +134,7 @@ Please read the [contribution guidelines][gh-stg-b-readme#contrib] of the [Arcti [gh-remarkjs/remark-lint]: https://github.com/remarkjs/remark-lint [gh-stg-b-readme#contrib]: https://github.com/arcticicestudio/styleguide-javascript#contributing [gh-stg-repo]: https://github.com/arcticicestudio/styleguide-javascript -[gh-t-pkg-esl-base]: https://github.com/arcticicestudio/styleguide-javascript/tree/develop/packages/@arcticicestudio/eslint-config-base +[gh-t-pkg-esl-base]: https://github.com/arcticicestudio/styleguide-javascript/tree/master/packages/@arcticicestudio/eslint-config-base [node-blog-peer_deps]: https://nodejs.org/en/blog/npm/peer-dependencies [node-dist-index]: https://nodejs.org/dist/index.json [node-dist-v8-latest]: https://nodejs.org/dist/latest-v8.x