From 08e781f91f317aefd0472004459148ff12451f66 Mon Sep 17 00:00:00 2001 From: Arctic Ice Studio Date: Mon, 5 Apr 2021 10:04:38 +0200 Subject: [PATCH] GitHub Flow migration Adapted to GitHub Flow [1] like documented in detail in the main task issue arcticicestudio/styleguide-git#9 [2]. [1]: https://guides.github.com/introduction/flow [2]: https://github.com/arcticicestudio/styleguide-git/issues/9 Co-authored-by: Sven Greb Subtask of arcticicestudio/styleguide-git#9 GH-19 --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .npmrc | 16 ++- .prettierignore | 1 + CHANGELOG.md | 4 +- CODE_OF_CONDUCT.md | 28 ++-- CONTRIBUTING.md | 122 ++++++++++-------- README.md | 8 +- lint-staged.config.js | 3 +- package.json | 13 +- .../remark-preset-lint/README.md | 13 +- .../remark-preset-lint/index.js | 4 +- .../remark-preset-lint/package.json | 18 ++- .../remark-preset-lint/rules/blockquotes.js | 2 +- .../remark-preset-lint/rules/code.js | 2 +- .../remark-preset-lint/rules/emphasis.js | 2 +- .../remark-preset-lint/rules/headings.js | 2 +- .../rules/horizontal-rules.js | 2 +- .../remark-preset-lint/rules/links.js | 2 +- .../remark-preset-lint/rules/lists.js | 2 +- .../rules/naming-conventions.js | 2 +- .../remark-preset-lint/rules/paragraphs.js | 2 +- .../remark-preset-lint/rules/raw-html.js | 2 +- .../remark-preset-lint/rules/strings.js | 2 +- .../remark-preset-lint/rules/tables.js | 2 +- .../remark-preset-lint/rules/whitespace.js | 2 +- src/README.md | 8 +- src/development/credits.md | 8 +- src/rules/accessibility-a11y.md | 4 +- src/rules/images.md | 2 +- src/rules/index.md | 2 +- src/rules/raw-html.md | 6 +- 31 files changed, 154 insertions(+), 134 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d28c08f..d655709 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-markdown/blob/develop/CONTRIBUTING.md) before filling out this pull request template**. +> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-markdown/blob/master/CONTRIBUTING.md) before filling out this pull request template**. ## Prerequisites diff --git a/.npmrc b/.npmrc index 76b80b3..5671c7d 100644 --- a/.npmrc +++ b/.npmrc @@ -2,11 +2,19 @@ # Copyright (c) 2018-present Sven Greb # This source code is licensed under the MIT license found in the LICENSE file. -# npm repository-wide configurations. -# See https://docs.npmjs.com for more details. +# npm configurations. +# See https://docs.npmjs.com/cli/v7/configuring-npm/npmrc for more details. -# Do not create a lockfile. +# Only use a lockfile for single-consumer projects, like applications, but not for multi-consumer projects like +# libraries. +# It can helps to pin dependency versions, improves the security through integrity checksums, prevents possible errors +# caused by updated transitive dependencies and allows to get deterministic build results, but it can hide problems in +# multi-consumer projects when any later versions of a used dependency, or its transitive dependencies, is not +# compatible with the own project anymore. +# See https://github.com/svengreb/tmpl/issues/70 for more details. package-lock=false -# Resolve to latest minor and patch updates. +# Resolve to the latest minor and patch updates. +# Enable to automatically pin dependencies to exact versions instead of resolving to latest minor and patch updates. +# This prevents possible errors caused by updated transitive dependencies. save-exact=false diff --git a/.prettierignore b/.prettierignore index 3c77120..2e9c571 100644 --- a/.prettierignore +++ b/.prettierignore @@ -5,4 +5,5 @@ # Path match pattern to ignore (i.e. not reformat) certain files and folders. # See https://prettier.io/docs/en/ignore for more details. +build/* **/node_modules/* diff --git a/CHANGELOG.md b/CHANGELOG.md index 971f841..8c937f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -

+

@@ -50,7 +50,7 @@

Copyright © 2018-present Arctic Ice Studio and Sven Greb

-

+

@@ -107,22 +108,25 @@ The [question][gh-issues-label-question] issue label is a good place to find ong ## Style Guides -Every major open source project has its own style guide, a set of standards and conventions for the writing and design of code, documentations and assets. It is much easier to understand a large codebase when all the code in it is in a consistent style. +Every major open source project has its own style guide, a set of standards and conventions for the writing and design of code, documentations and Git commit messages. It is much easier to understand a large code base when all the code in it is in a consistent style. A style guide establishes and enforces style to improve the intelligibility and communication within the project community. It ensures consistency and enforces best practice in usage and language composition. +### JavaScript Style Guide + +styleguide-markdown adheres to the [Arctic Ice Studio JavaScript code style guide][gh-styleguide-javascript]. + ### Git Commit Messages A well-crafted Git commit message is the best way to communicate _context_ about a change to the maintainers. The code will tell what changed, but only the commit message can properly tell why. Re-establishing the context of a piece of code is wasteful. We can't avoid it completely, so our efforts should go to reducing it as much as possible. -styleguide-markdown adheres to the [Arctic Ice Studio Git Style Guide][styleguide-git-github]. -The style guide assumes that you are familiar with the [gitflow][gitflow] branching model. +styleguide-markdown adheres to the [Arctic Ice Studio Git style guide][gh-styleguide-git]. The style guide assumes that you are familiar with the [GitHub Flow][ghg-flow] branching model. ## MCVE A Minimal, Complete, and Verifiable Example. -When [reporting a bug](#bug-reports), somtimes even when [suggestig a enhancement](#enhancement-suggestions), the issue can be processed faster if you provide code for reproduction. That code should be… +When [reporting a bug](#bug-reports), sometimes even when [suggesting enhancements](#enhancement-suggestions), the issue can be processed faster if you provide code for reproduction. That code should be… - …Minimal – Use as little code as possible that still produces the same behavior - …Complete – Provide all parts needed to reproduce the behavior @@ -130,7 +134,7 @@ When [reporting a bug](#bug-reports), somtimes even when [suggestig a enhancemen A MCVE is a common practice like on [Stack Overflow][stackoverflow-mcve] and sometimes it is also called [SSCCE][sscce], a _Short, Self Contained, Correct (Compilable), Example_. -The recommended way for GitHub based projects is to create it as [Gist](https://gist.github.com) or new repository, but of course you can [attach it to issues and pull requests as files](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests), use any free code paste- or file hosting service or paste the code in [Markdown code blocks][gh-help-markdown-code-blocks] into the issue. +The recommended way for GitHub based projects is to create it as [Gist][gh-gist] or new repository, but of course you can [attach it to issues and pull requests as files][ghd-attach-file], use any free code paste- or file hosting service or paste the code in [Markdown code blocks][ghd-markdown-code-blocks] into the issue. ### Minimal @@ -141,7 +145,7 @@ The more code there is to go through, the less likely developers can understand #### Minimal and readable -Minimal does not mean terse – don't sacrifice communication to brevity. Use consistent naming and indentation following the [styleguide](#style-guides), and include comments if needed to explain portions of the code. +Minimal does not mean terse – don't sacrifice communication to brevity. Use consistent naming and indentation following the [style guides](#style-guides), and include comments if needed to explain portions of the code. ### Complete @@ -159,33 +163,37 @@ To entirely understand your enhancement or bug report, developers will need to v styleguide-markdown follows the [Semantic Versioning Specification][semver] (SemVer). We release patch versions for bug fixes, minor versions for enhancements like new features and improvements, and major versions for any backwards incompatible changes. Deprecation warnings are introduced for breaking changes in a minor version so that users learn about the upcoming changes and migrate their code in advance. -Every significant change is documented in the [changelog][changelog]. +Every significant change is documented in the [changelog][gh-changelog]. ## Credits -Thanks for the inspirations and attributions to GitHub's [Open Source Guides](https://opensource.guide) and various contribution guides of large open source projects like [Atom][ref-atom-contributing], [React][ref-react-contributing] and [Ruby on Rails][ref-rubyonrails-contributing]. - -[branch-develop]: https://github.com/arcticicestudio/styleguide-markdown/tree/develop -[changelog]: https://github.com/arcticicestudio/styleguide-markdown/blob/develop/CHANGELOG.md -[code-of-conduct]: https://github.com/arcticicestudio/styleguide-markdown/blob/develop/CODE_OF_CONDUCT.md -[email]: mailto:development@arcticicestudio.com -[gh-help-attach-files]: https://help.github.com/articles/file-attachments-on-issues-and-pull-requests -[gh-help-issue-keywords]: https://help.github.com/articles/closing-issues-using-keywords -[gh-help-markdown-code-blocks]: https://help.github.com/articles/basic-writing-and-formatting-syntax -[gh-issues-label-question]: https://github.com/arcticicestudio/styleguide-markdown/labels/question +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-markdown/tree/main +[gh-changelog]: https://github.com/arcticicestudio/styleguide-markdown/blob/main/CHANGELOG.md +[gh-coc]: https://github.com/arcticicestudio/styleguide-markdown/blob/main/CODE_OF_CONDUCT.md +[gh-gist]: https://gist.github.com +[gh-issues-label-question]: https://github.com/arcticicestudio/styleguide-markdown/labels/type-question +[gh-issues-template-bug]: https://github.com/arcticicestudio/styleguide-markdown/blob/main/.github/ISSUE_TEMPLATE/bugs.md +[gh-issues-template-enhancement]: https://github.com/arcticicestudio/styleguide-markdown/blob/main/.github/ISSUE_TEMPLATE/enhancement.md +[gh-issues-template-pr]: https://github.com/arcticicestudio/styleguide-markdown/blob/main/.github/PULL_REQUEST_TEMPLATE.md +[gh-issues-templates]: https://github.com/arcticicestudio/styleguide-markdown/issues/new/choose [gh-issues]: https://github.com/arcticicestudio/styleguide-markdown/issues -[gh-osguide-contribute]: https://opensource.guide/how-to-contribute +[gh-mailmap]: https://github.com/arcticicestudio/styleguide-markdown/blob/main/.mailmap [gh-pr]: https://github.com/arcticicestudio/styleguide-markdown/pulls +[gh-releases-latest]: https://github.com/arcticicestudio/styleguide-markdown/releases/latestsanitize=true +[gh-styleguide-git]: https://github.com/arcticicestudio/styleguide-git +[gh-styleguide-javascript]: https://github.com/arcticicestudio/styleguide-javascript +[ghd-attach-file]: https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests +[ghd-issue-keywords]: https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue +[ghd-markdown-code-blocks]: https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax +[ghg-flow]: https://guides.github.com/introduction/flow [git-docs-branching-workflows]: https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows -[gitflow]: http://nvie.com/posts/a-successful-git-branching-model -[nodejs]: https://nodejs.org -[ref-atom-contributing]: https://github.com/atom/atom/blob/master/CONTRIBUTING.md -[ref-react-contributing]: https://facebook.github.io/react/contributing/how-to-contribute.html -[ref-rubyonrails-contributing]: http://guides.rubyonrails.org/contributing_to_ruby_on_rails.html -[semver]: http://semver.org +[os-guide-contrib]: https://opensource.guide/how-to-contribute +[os-guide]: https://opensource.guide +[react-contrib]: https://facebook.github.io/react/contributing/how-to-contribute.html +[ruby-on-rails-contrib]: http://guides.rubyonrails.org/contributing_to_ruby_on_rails.html +[semver]: https://semver.org [sscce]: http://sscce.org [stackoverflow-mcve]: https://stackoverflow.com/help/mcve -[styleguide-git-github]: https://github.com/arcticicestudio/styleguide-git -[template-issue]: https://github.com/arcticicestudio/styleguide-markdown/blob/develop/.github/ISSUE_TEMPLATE.md -[template-pr]: https://github.com/arcticicestudio/styleguide-markdown/blob/develop/.github/PULL_REQUEST_TEMPLATE.md -[version-latest]: https://github.com/arcticicestudio/styleguide-markdown/releases/latest diff --git a/README.md b/README.md index b3032a6..9f168ec 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -

+

The Arctic Ice Studio Markdown code style.

-

+

@@ -33,7 +33,7 @@ The guide also includes information about [minimal, complete, and verifiable exa

Copyright © 2018-present Arctic Ice Studio and Sven Greb

-

+

[commonmark]: http://commonmark.org [docs-dev-building]: https://arcticicestudio.github.io/styleguide-markdown/development/building.html @@ -60,5 +60,5 @@ The guide also includes information about [minimal, complete, and verifiable exa [docs]: https://arcticicestudio.github.io/styleguide-markdown [gfm]: https://github.github.com/gfm [gh-remarkjs/remark-lint]: https://github.com/remarkjs/remark-lint -[gh-tree-pkg-remark-preset-lint]: https://github.com/arcticicestudio/styleguide-markdown/tree/develop/packages/@arcticicestudio/remark-preset-lint +[gh-tree-pkg-remark-preset-lint]: https://github.com/arcticicestudio/styleguide-markdown/tree/master/packages/@arcticicestudio/remark-preset-lint [remark]: https://remark.js.org diff --git a/lint-staged.config.js b/lint-staged.config.js index 0531948..7ffb8a0 100644 --- a/lint-staged.config.js +++ b/lint-staged.config.js @@ -10,6 +10,7 @@ * @see https://github.com/okonet/lint-staged#configuration */ module.exports = { - "*.{css,html,js,json,yaml,yml}": ["eslint", "prettier --check"], + "*.{css,html,js,json,yaml,yml}": "prettier --check", + "*.js": ["eslint", "prettier --check"], "*.md": ["remark --no-stdout", "prettier --check"], }; diff --git a/package.json b/package.json index 0e0d3d5..71eafda 100644 --- a/package.json +++ b/package.json @@ -24,15 +24,6 @@ "node": "^15.13.0", "npm": "^7.7.0" }, - "keywords": [ - "style", - "guide", - "markdown", - "remark", - "remark-lint", - "rule", - "preset" - ], "workspaces": [ "packages/@arcticicestudio/*" ], @@ -48,14 +39,14 @@ "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", "test": "npm --workspaces run test" }, "devDependencies": { - "@arcticicestudio/eslint-config-base": ">=0.8.0 <1.0.0", + "@arcticicestudio/eslint-config-base": ">=0.9.0 <1.0.0", "del-cli": "^3.0.1", "eslint": "^7.23.0", "eslint-config-prettier": "^8.1.0", diff --git a/packages/@arcticicestudio/remark-preset-lint/README.md b/packages/@arcticicestudio/remark-preset-lint/README.md index f8937a2..9742b29 100644 --- a/packages/@arcticicestudio/remark-preset-lint/README.md +++ b/packages/@arcticicestudio/remark-preset-lint/README.md @@ -1,19 +1,18 @@ -

+

The Arctic Ice Studio Markdown code style guide rules as an extensible remark-lint rule preset.

-

+

-This project implements the rules of the [“Arctic Ice Studio Markdown Style Guide”][gh-arcticicestudio/styleguide-markdown] as an extensible [remark-lint][gh-remarkjs/remark-lint] rule preset. -The package supports all [official core rules][gh-remarkjs/remark-lint-blob-docs-rules] and [various plugins][gh-remarkjs/remark-blob-docs-plugins] like the [“frontmatter” Markdown extension][gh-remarkjs/remark-frontmatter] for [YAML][] and [TOML][gh-toml-lang/toml] and [“GitHub Flavoured“ Markdown][gh-remarkjs/remark-gfm]. +This package implements the rules of the [Arctic Ice Studio Markdown style guide][gh-arcticicestudio/styleguide-markdown] as an extensible [remark-lint][gh-remarkjs/remark-lint] rule preset. It supports all [official core rules][gh-remarkjs/remark-lint-blob-docs-rules] and [various plugins][gh-remarkjs/remark-blob-docs-plugins] like the [“frontmatter” Markdown extension][gh-remarkjs/remark-frontmatter] for [YAML][] and [TOML][gh-toml-lang/toml] and [“GitHub Flavoured” Markdown][gh-remarkjs/remark-gfm]. ## Getting Started -Note that this project uses [npm version 7.7.0 or higher][gh-blog-npm_v7] as the main package manager, but the documentations also include instructions to work with [Yarn][yarn-classic] (classic / `v1`). +Note that this package uses [npm version 7.7.0 or higher][gh-blog-npm_v7] as the main package manager, but the documentations also include instructions to work with [Yarn][yarn-classic] (classic / `v1`). ### Installation @@ -96,13 +95,13 @@ module.exports = { ## Contributing -Please read the [contribution guidelines][ghio-arcticicestudio/styleguide-markdown-dev-contributing] of the [“Arctic Ice Studio Markdown Style Guide”][gh-arcticicestudio/styleguide-markdown] for more details. +Please read the [contribution guidelines][ghio-arcticicestudio/styleguide-markdown-dev-contributing] of the [Arctic Ice Studio Markdown style guide][gh-arcticicestudio/styleguide-markdown] for more details.

Copyright © 2018-present Arctic Ice Studio and Sven Greb

-

+

[gh-arcticicestudio/styleguide-markdown]: https://github.com/arcticicestudio/styleguide-markdown [gh-blog-npm_v7]: https://github.blog/2020-10-13-presenting-v7-0-0-of-the-npm-cli diff --git a/packages/@arcticicestudio/remark-preset-lint/index.js b/packages/@arcticicestudio/remark-preset-lint/index.js index 1b2d02e..f27aa31 100644 --- a/packages/@arcticicestudio/remark-preset-lint/index.js +++ b/packages/@arcticicestudio/remark-preset-lint/index.js @@ -10,9 +10,11 @@ * @license MIT * @author Arctic Ice Studio * @author Sven Greb + * @copyright 2018-present Arctic Ice Studio + * @copyright 2018-present Sven Greb * @see https://github.com/remarkjs/remark-lint * @see https://remark.js.org - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules * @see https://github.com/remarkjs/remark-lint#configuring-remark-lint */ module.exports = { diff --git a/packages/@arcticicestudio/remark-preset-lint/package.json b/packages/@arcticicestudio/remark-preset-lint/package.json index d0b4d7f..c7b5652 100644 --- a/packages/@arcticicestudio/remark-preset-lint/package.json +++ b/packages/@arcticicestudio/remark-preset-lint/package.json @@ -3,6 +3,13 @@ "version": "0.3.0", "description": "Arctic Ice Studio Markdown code style guide rules as an extensible remark-lint rule preset", "author": "Arctic Ice Studio (https://www.arcticicestudio.com)", + "contributors": [ + { + "name": "Sven Greb", + "email": "development@svengreb.de", + "url": "https://www.svengreb.de" + } + ], "homepage": "https://github.com/arcticicestudio/styleguide-markdown", "repository": { "type": "git", @@ -14,12 +21,13 @@ }, "license": "MIT", "keywords": [ - "remark", - "lint", - "preset", + "style", + "guide", "markdown", - "styleguide", - "codestyle" + "remark", + "remark-lint", + "rule", + "preset" ], "main": "index.js", "files": [ diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/blockquotes.js b/packages/@arcticicestudio/remark-preset-lint/rules/blockquotes.js index 2028b03..10cecd9 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/blockquotes.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/blockquotes.js @@ -24,7 +24,7 @@ const noBlockquoteWithoutMarker = require("remark-lint-no-blockquote-without-mar * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [ diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/code.js b/packages/@arcticicestudio/remark-preset-lint/rules/code.js index e9e8273..bbbb47f 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/code.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/code.js @@ -38,7 +38,7 @@ const noShellDollars = require("remark-lint-no-shell-dollars"); * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [ diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/emphasis.js b/packages/@arcticicestudio/remark-preset-lint/rules/emphasis.js index 906ccac..7234b2d 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/emphasis.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/emphasis.js @@ -41,7 +41,7 @@ const strongMarker = require("remark-lint-strong-marker"); * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [ diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/headings.js b/packages/@arcticicestudio/remark-preset-lint/rules/headings.js index d570342..a6bf111 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/headings.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/headings.js @@ -83,7 +83,7 @@ const noMultipleToplevelHeadings = require("remark-lint-no-multiple-toplevel-hea * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [ diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/horizontal-rules.js b/packages/@arcticicestudio/remark-preset-lint/rules/horizontal-rules.js index 8b6ef93..1f8e097 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/horizontal-rules.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/horizontal-rules.js @@ -17,7 +17,7 @@ const ruleStyle = require("remark-lint-rule-style"); * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [[ruleStyle, ["error", "---"]]], diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/links.js b/packages/@arcticicestudio/remark-preset-lint/rules/links.js index 7a06247..9ffd46d 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/links.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/links.js @@ -91,7 +91,7 @@ const noUnusedDefinitions = require("remark-lint-no-unused-definitions"); * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [ diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/lists.js b/packages/@arcticicestudio/remark-preset-lint/rules/lists.js index 6bc1184..c7dc58c 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/lists.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/lists.js @@ -72,7 +72,7 @@ const unorderedListMarkerStyle = require("remark-lint-unordered-list-marker-styl * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [ diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/naming-conventions.js b/packages/@arcticicestudio/remark-preset-lint/rules/naming-conventions.js index 12abf47..f36f240 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/naming-conventions.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/naming-conventions.js @@ -48,7 +48,7 @@ const noFileNameOuterDashes = require("remark-lint-no-file-name-outer-dashes"); * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [ diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/paragraphs.js b/packages/@arcticicestudio/remark-preset-lint/rules/paragraphs.js index 3e16dba..f22c7eb 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/paragraphs.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/paragraphs.js @@ -17,7 +17,7 @@ const noParagraphContentIndent = require("remark-lint-no-paragraph-content-inden * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [[noParagraphContentIndent, ["error"]]], diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/raw-html.js b/packages/@arcticicestudio/remark-preset-lint/rules/raw-html.js index 4de1df9..23d59b7 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/raw-html.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/raw-html.js @@ -16,7 +16,7 @@ const noHtml = require("remark-lint-no-html"); * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [[noHtml, false]], diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/strings.js b/packages/@arcticicestudio/remark-preset-lint/rules/strings.js index 6e3c382..42ea73a 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/strings.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/strings.js @@ -17,7 +17,7 @@ const linkTitleStyle = require("remark-lint-link-title-style"); * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [[linkTitleStyle, ["error", '"']]], diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/tables.js b/packages/@arcticicestudio/remark-preset-lint/rules/tables.js index c8cc5b1..a5d4273 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/tables.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/tables.js @@ -39,7 +39,7 @@ const tablePipes = require("remark-lint-table-pipes"); * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [ diff --git a/packages/@arcticicestudio/remark-preset-lint/rules/whitespace.js b/packages/@arcticicestudio/remark-preset-lint/rules/whitespace.js index baa7de6..2c70cbd 100644 --- a/packages/@arcticicestudio/remark-preset-lint/rules/whitespace.js +++ b/packages/@arcticicestudio/remark-preset-lint/rules/whitespace.js @@ -59,7 +59,7 @@ const noTabs = require("remark-lint-no-tabs"); * @author Arctic Ice Studio * @author Sven Greb * @since 0.1.0 - * @see https://github.com/remarkjs/remark-lint/blob/master/doc/rules.md#list-of-rules + * @see https://github.com/remarkjs/remark-lint/blob/main/doc/rules.md#list-of-rules */ module.exports = { plugins: [ diff --git a/src/README.md b/src/README.md index b3032a6..9f168ec 100644 --- a/src/README.md +++ b/src/README.md @@ -1,8 +1,8 @@ -

+

The Arctic Ice Studio Markdown code style.

-

+

@@ -33,7 +33,7 @@ The guide also includes information about [minimal, complete, and verifiable exa

Copyright © 2018-present Arctic Ice Studio and Sven Greb

-

+

[commonmark]: http://commonmark.org [docs-dev-building]: https://arcticicestudio.github.io/styleguide-markdown/development/building.html @@ -60,5 +60,5 @@ The guide also includes information about [minimal, complete, and verifiable exa [docs]: https://arcticicestudio.github.io/styleguide-markdown [gfm]: https://github.github.com/gfm [gh-remarkjs/remark-lint]: https://github.com/remarkjs/remark-lint -[gh-tree-pkg-remark-preset-lint]: https://github.com/arcticicestudio/styleguide-markdown/tree/develop/packages/@arcticicestudio/remark-preset-lint +[gh-tree-pkg-remark-preset-lint]: https://github.com/arcticicestudio/styleguide-markdown/tree/master/packages/@arcticicestudio/remark-preset-lint [remark]: https://remark.js.org diff --git a/src/development/credits.md b/src/development/credits.md index 47ba2f8..47e464f 100644 --- a/src/development/credits.md +++ b/src/development/credits.md @@ -5,13 +5,13 @@ If you use this style guide in your project, you can include these badges in the ![Markdown Style Guide Badge][badge-styleguide-markdown] ```md -[![Markdown Style Guide](https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/develop/assets/styleguide-markdown-banner-typography-badge.svg?sanitize=true) +[![Markdown Style Guide](https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/master/assets/styleguide-markdown-banner-typography-badge.svg?sanitize=true) ``` ![Code Style Badge][badge-styleguide-code-style] ```md -[![Markdown Style Guide](https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/develop/assets/styleguide-badge-code-style.svg?sanitize=true) +[![Markdown Style Guide](https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/master/assets/styleguide-badge-code-style.svg?sanitize=true) ``` ![Markdown Style Guide Badge Version][badge-shield-code-style-version] @@ -36,8 +36,8 @@ If you use this style guide in your project, you can include these badges in the [badge-shield-code-style]: https://img.shields.io/badge/%20-Code_Style-88C0D0.svg?style=flat-square&colorA=2E3440&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzOSIgaGVpZ2h0PSIzOSIgdmlld0JveD0iMCAwIDM5IDM5Ij48cGF0aCBmaWxsPSJub25lIiBzdHJva2U9IiNEOERFRTkiIHN0cm9rZS13aWR0aD0iMyIgc3Ryb2tlLW1pdGVybGltaXQ9IjEwIiBkPSJNMS41IDEuNWgzNnYzNmgtMzZ6Ii8%2BPHBhdGggZmlsbD0iI0Q4REVFOSIgZD0iTTIwLjY4MyAyNS42NTVsNS44NzItMTMuNDhoLjU2Nmw1Ljg3MyAxMy40OGgtMS45OTZsLTQuMTU5LTEwLjA1Ni00LjE2MSAxMC4wNTZoLTEuOTk1em0tMi42OTYgMGwtMTMuNDgtNS44NzJ2LS41NjZsMTMuNDgtNS44NzJ2MS45OTVMNy45MzEgMTkuNWwxMC4wNTYgNC4xNnoiLz48L3N2Zz4%3D [badge-shield-code-style-inverted]: https://img.shields.io/badge/%20-Code_Style-2E3440.svg?style=flat-square&colorA=ffffff&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzMi41IiBoZWlnaHQ9IjMyLjUiIHZpZXdCb3g9IjAgMCAzMi41IDMyLjUiPjxwYXRoIGZpbGw9Im5vbmUiIHN0cm9rZT0iIzJFMzQ0MCIgc3Ryb2tlLXdpZHRoPSIuNSIgc3Ryb2tlLW1pdGVybGltaXQ9IjEwIiBkPSJNLjI1LjI1aDMydjMyaC0zMnoiLz48cGF0aCBmaWxsPSIjMkUzNDQwIiBkPSJNMTcuNDMzIDIyLjQwNWw1Ljg3Mi0xMS45OGguNTY2bDUuODczIDExLjk4aC0uNDk2bC01LjY1OS0xMS41NTYtNS42NjEgMTEuNTU2aC0uNDk1em0tMi42OTYgMGwtMTEuOTgtNS44NzN2LS41NjZsMTEuOTgtNS44NzJ2LjQ5NUwzLjE4MSAxNi4yNWwxMS41NTYgNS42NnYuNDk1eiIvPjwvc3ZnPg%3D%3D [badge-shield-code-style-version]: https://img.shields.io/badge/Markdown_Style_Guide-0.2.0-88C0D0.svg?style=flat-square&colorA=2E3440&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzOSIgaGVpZ2h0PSIzOSIgdmlld0JveD0iMCAwIDM5IDM5Ij48cGF0aCBmaWxsPSJub25lIiBzdHJva2U9IiNEOERFRTkiIHN0cm9rZS13aWR0aD0iMyIgc3Ryb2tlLW1pdGVybGltaXQ9IjEwIiBkPSJNMS41IDEuNWgzNnYzNmgtMzZ6Ii8%2BPHBhdGggZmlsbD0iI0Q4REVFOSIgZD0iTTIwLjY4MyAyNS42NTVsNS44NzItMTMuNDhoLjU2Nmw1Ljg3MyAxMy40OGgtMS45OTZsLTQuMTU5LTEwLjA1Ni00LjE2MSAxMC4wNTZoLTEuOTk1em0tMi42OTYgMGwtMTMuNDgtNS44NzJ2LS41NjZsMTMuNDgtNS44NzJ2MS45OTVMNy45MzEgMTkuNWwxMC4wNTYgNC4xNnoiLz48L3N2Zz4%3D -[badge-styleguide-code-style]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/develop/assets/styleguide-badge-code-style.svg?sanitize=true -[badge-styleguide-markdown]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/develop/assets/styleguide-markdown-banner-typography-badge.svg?sanitize=true +[badge-styleguide-code-style]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/master/assets/styleguide-badge-code-style.svg?sanitize=true +[badge-styleguide-markdown]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/master/assets/styleguide-markdown-banner-typography-badge.svg?sanitize=true [google-docguide-gh]: https://github.com/google/styleguide/blob/gh-pages/docguide [google-developer-doc-style-guide]: https://developers.google.com/style/ [markdown_style_guide-ciro_santilli]: http://www.cirosantilli.com/markdown-style-guide diff --git a/src/rules/accessibility-a11y.md b/src/rules/accessibility-a11y.md index cc4c9f0..023c70f 100644 --- a/src/rules/accessibility-a11y.md +++ b/src/rules/accessibility-a11y.md @@ -13,7 +13,7 @@ Add an alternative text for images. ```markdown ![][snowflake] -[snowflake]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/develop/src/assets/snowflake.png +[snowflake]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/master/src/assets/snowflake.png ``` @@ -23,7 +23,7 @@ Add an alternative text for images. ```markdown ![snowflake icon][snowflake] -[snowflake]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/develop/src/assets/snowflake.png +[snowflake]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/master/src/assets/snowflake.png ``` [a11y]: https://a11yproject.com diff --git a/src/rules/images.md b/src/rules/images.md index df5a547..11931e4 100644 --- a/src/rules/images.md +++ b/src/rules/images.md @@ -21,7 +21,7 @@ Prefer absolute URLs instead of relative ones to improve the portability of the ```markdown ![snowflake icon][snowflake] snowflakes falling down in the winter! -[snowflake]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/develop/src/assets/snowflake.png +[snowflake]: https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/master/src/assets/snowflake.png ``` ## Badges diff --git a/src/rules/index.md b/src/rules/index.md index b964eae..6fca054 100644 --- a/src/rules/index.md +++ b/src/rules/index.md @@ -1,4 +1,4 @@ -

+

This section contains rules for Markdown with support for GitHub Flavored Markdown which is based on the CommonMark specification. diff --git a/src/rules/raw-html.md b/src/rules/raw-html.md index 45338a6..1e2795d 100644 --- a/src/rules/raw-html.md +++ b/src/rules/raw-html.md @@ -38,13 +38,13 @@ Although MDN states that the `width` and `height` attributes are deprecated and ```markdown -Sparkling snowflakes falling down in the winter! +Sparkling snowflakes falling down in the winter! ``` No way to define the size: ```markdown -Sparkling ![snowflake icon](https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/develop/src/assets/snowflake.png) snowflakes falling down in the winter! +Sparkling ![snowflake icon](https://raw.githubusercontent.com/arcticicestudio/styleguide-markdown/master/src/assets/snowflake.png) snowflakes falling down in the winter! ``` @@ -52,7 +52,7 @@ Sparkling ![snowflake icon](https://raw.githubusercontent.com/arcticicestudio/st ⇡ **Correct** code for this rule: ```markdown -Sparkling snowflakes falling down in the winter! +Sparkling snowflakes falling down in the winter! ``` ## Collapsed Content