Skip to content

Commit acd0df4

Browse files
remark-lint (#54)
* 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
1 parent 7a6fdd3 commit acd0df4

File tree

5 files changed

+4169
-0
lines changed

5 files changed

+4169
-0
lines changed

.gitignore

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,16 @@
44
# Project: snowsaw
55
# Repository: https://github.com/arcticicestudio/snowsaw
66
# License: MIT
7+
8+
# +------+
9+
# + Logs +
10+
# +------+
11+
**/*.log
12+
logs/
13+
npm-debug.log*
14+
15+
# +---------+
16+
# + Node.js +
17+
# +---------+
18+
.npm/
19+
**/node_modules/

.remarkignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Copyright (C) 2017-present Arctic Ice Studio <[email protected]>
2+
# Copyright (C) 2017-present Sven Greb <[email protected]>
3+
#
4+
# Project: snowsaw
5+
# Repository: https://github.com/arcticicestudio/snowsaw
6+
# License: MIT
7+
8+
**/node_modules/*

.remarkrc.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/*
2+
* Copyright (C) 2017-present Arctic Ice Studio <[email protected]>
3+
* Copyright (C) 2017-present Sven Greb <[email protected]>
4+
*
5+
* Project: snowsaw
6+
* Repository: https://github.com/arcticicestudio/snowsaw
7+
* License: MIT
8+
*/
9+
10+
/**
11+
* @file The remark-lint configuration.
12+
* @author Arctic Ice Studio <[email protected]>
13+
* @author Sven Greb <[email protected]>
14+
*/
15+
16+
module.exports = {
17+
plugins: ["remark-preset-lint-arcticicestudio"]
18+
};

0 commit comments

Comments
 (0)