Skip to content

Commit

Permalink
remark-lint (#54)
Browse files Browse the repository at this point in the history
* Install `remark-cli` and `remark-preset-lint-arcticicestudio` NPM pkgs.

Installed remark-lint (1) through `remark-cli` (2) using the
`remark-preset-lint-arcticicestudio` (3) preset that implements the
"Arctic ice Studio" Markdown Style Guide (4).

Also updated the Git ignore pattern to handle "Node.js" data.

References:
  (1) remarkjs/remark-lint
  (2) npmjs.com/package/remark-cli
  (3) arcticicestudio/remark-preset-lint-arcticicestudio
  (4) arcticicestudio.github.io/styleguide-markdown

Epic: GH-33
Depends on GH-47 GH-49
GH-36

<--------------------------------------------------------------------->

* Implement remark config and ignore pattern file

Created the main remark (1) configuration file and initially set up the
`remark-preset-lint-arcticicestudio` (2) preset.
Also added the `.remarkignore` file with to define ignore pattern.

References:
  (1) remark.js.org
  (2) remarkjs/remark-lint
  (3) arcticicestudio/remark-preset-lint-arcticicestudio

Epic: GH-33
Depends on GH-47 GH-49
GH-36

<--------------------------------------------------------------------->

* Implement NPM script/task to lint Markdown files

The NPM scripts/tasks allow to run the Markdown linting separately and
as well as running the all `lint` task together.

Also added the `npm-run-all` package that simplifies the paralell and
serial execution of multiple NPM scripts/tasks including name wildcard
support.

Epic: GH-33
Depends on GH-47 GH-49
GH-36
  • Loading branch information
arcticicestudio authored Jun 22, 2019
1 parent 7a6fdd3 commit acd0df4
Show file tree
Hide file tree
Showing 5 changed files with 4,169 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,16 @@
# Project: snowsaw
# Repository: https://github.com/arcticicestudio/snowsaw
# License: MIT

# +------+
# + Logs +
# +------+
**/*.log
logs/
npm-debug.log*

# +---------+
# + Node.js +
# +---------+
.npm/
**/node_modules/
8 changes: 8 additions & 0 deletions .remarkignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Copyright (C) 2017-present Arctic Ice Studio <development@arcticicestudio.com>
# Copyright (C) 2017-present Sven Greb <development@svengreb.de>
#
# Project: snowsaw
# Repository: https://github.com/arcticicestudio/snowsaw
# License: MIT

**/node_modules/*
18 changes: 18 additions & 0 deletions .remarkrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/*
* Copyright (C) 2017-present Arctic Ice Studio <development@arcticicestudio.com>
* Copyright (C) 2017-present Sven Greb <development@svengreb.de>
*
* Project: snowsaw
* Repository: https://github.com/arcticicestudio/snowsaw
* License: MIT
*/

/**
* @file The remark-lint configuration.
* @author Arctic Ice Studio <development@arcticicestudio.com>
* @author Sven Greb <development@svengreb.de>
*/

module.exports = {
plugins: ["remark-preset-lint-arcticicestudio"]
};
Loading

0 comments on commit acd0df4

Please sign in to comment.