Skip to content

Commit

Permalink
Refactor project to monorepo
Browse files Browse the repository at this point in the history
...and refactor the project as a whole.

* remark(1) is now `remark-cli`;
* remark(3) is now `remark`, but is split into
  `remark-parse` and `remark-stringify`.

Major changes
-------------

There’s a lot less duplicate documentation between the
different projects.  Although this does require more
navigation between links, this should make things clearer
for newcomers who don’t know what’s what.

* Externalise remark(1) into `unified-engine` (API) and
  `unified-args` (CLI creator), which comes with a huge
  refactor, 100% coverage, and lots of bug fixes.

* Update to use [email protected], which comes with a much
  simpler interface, includes a streaming interface,
  better support for combining processors, and allows
  transformers to provide a new syntax tree instead of
  only allowing modifications.

  The most notable change is that `remark.process()` and
  the like no longer work, switch instead to using
  `remark().process()`.

  Read more: <https://github.com/wooorm/unified/releases/tag/4.0.0>

* The parser and compiler are now their own packages,
  which, combined with [email protected] means browsers can
  pack less weight if either isn’t required.  Additionally,
  docs for interacting with the parser and the compiler are
  included.  Those docs result in more of the previously
  private interface to be publicised, which resulted in
  some changes for the better:

  * `tokenizer.onlyAtTop` > `tokenizer.notInList`;
  * `Processor#atTop` > `Processor#inList`;
  * `Processor#exitTop` > `Processor#enterList`;
  * `tokenizer.notInBlockquote` > `tokenizer.notInBlock`;
  * `Processor#inBlockquote` > `Processor#inBlock`;
  * `Processor#enterBlockquote` > `Processor#enterBlock`;
  * `blockTokenizers.heading` > `blockTokenizers.atxHeading`;
  * `blockTokenizers.lineHeading` > `blockTokenizers.setextHeading`;
  * `blockTokenizers.code` > `blockTokenizers.indentedCode`;
  * `blockTokenizers.fences` > `blockTokenizers.fencedCode`;
  * `blockTokenizers.footnoteDefinition` > `blockTokenizers.footnote`;
  * `inlineTokenizers.inlineText` > `inlineTokenizers.text`;
  * `inlineTokenizers.tag` > `inlineTokenizers.html`;
  * `inlineTokenizers.inlineCode` > `inlineTokenizers.code`.

Minor changes
-------------

* Rewrite tests, using tape instead of mocha, and execa for
  CLI tests.
* Remove man pages.
* Update docs.
* Add Node@^6.0.0 to Travis targets.
* Refactor code style.
* Fix bug in positional information when using BOMs.
* Lower-case `Remark` > `remark` in logo.
  • Loading branch information
wooorm committed Jun 12, 2016
1 parent 2c86b08 commit 8108fe5
Show file tree
Hide file tree
Showing 831 changed files with 2,864 additions and 12,355 deletions.
7 changes: 3 additions & 4 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
build/
coverage/
build.js
**/coverage
**/node_modules
packages/remark/cli.js
remark.js
remark.min.js
example.js
7 changes: 3 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.DS_Store
.nyc_output
*.log
build/
node_modules/
coverage/
build.js
node_modules
coverage
remark.js
remark.min.js
10 changes: 5 additions & 5 deletions .jscs.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
{
"excludeFiles": [
"build/",
"coverage/",
"node_modules/",
"build.js",
"**/coverage",
"**/node_modules",
"packages/remark/cli.js",
"remark.js",
"remark.min.js"
],
Expand All @@ -15,7 +14,8 @@
"value": 79,
"allExcept": [
"regex",
"urlComments"
"urlComments",
"require"
]
},
"requireQuotedKeysInObjects": true,
Expand Down
4 changes: 0 additions & 4 deletions .remarkignore

This file was deleted.

10 changes: 0 additions & 10 deletions .remarkrc-man

This file was deleted.

26 changes: 15 additions & 11 deletions .remarkrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,22 @@
module.exports = {
'output': true,
'plugins': {
/* Custom natural-language validation. */
'script/natural-language': null,
'comment-config': null,
'lint': {
/* Ignore `final-definition` for `license` */
'final-definition': false
// 'comment-config': null,
// 'github': null,
// 'validate-links': null,
'toc': {
'maxDepth': 3,
'tight': true
},
'github': null,
'usage': null,
'toc': null,
'license': null,
'validate-links': null
'lint': {
/* `h6` for signatures. */
'no-duplicate-headings': false,
'heading-increment': false,

/* Lists. */
'list-item-spacing': false,
'no-missing-blank-lines': false
}
},
'settings': {
/* I personally like asterisks. */
Expand Down
13 changes: 4 additions & 9 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,21 +1,15 @@
language: node_js
script: npm run-script test-travis
node_js:
- '0.10'
- '0.11'
- '0.12'
- '4.0'
- '5.0'
after_script: npm install codecov.io && cat ./coverage/lcov.info | codecov
- '6.0'
after_success:
- bash <(curl -s https://codecov.io/bash)
sudo: false
deploy:
- provider: npm
email: [email protected]
api_key:
secure: h4ADxR4z3G3m7hweVZlq64ytgENE4UPUesnpiQbwcRBcQy79TNcITWJ/61yEnhEHB94FEuP/rMC3KU2Ho7kinyeO/JNoK1YlhVKKBZuIYwsJ4Op3ndwZ71TCPe0wIbWxOfhO9L7t6oytNnPg9gWNqLkQW8rBZ+ujdcdtMQ82XZE=
on:
tags: true
node: '5.0'
- provider: releases
api_key:
secure: GCfTZxoqpp1tMmslM5MTI13BLv+bvFhZUuhX+dQFbcVYODQKUjnUj9EBF10PJSTpYqm3GnGpxEoQ6RAUVxlH7rBQUFm4czaZPPgCDSZT3B8pszmQkl1aRyvdmXFoKfyNhFUwBUSsoBpM92wp/UrgIZ/CI0jLoIZbCwn4KH02rf8=
Expand All @@ -24,3 +18,4 @@ deploy:
- "remark.min.js"
on:
tags: true
node: '6.0'
38 changes: 0 additions & 38 deletions AUTHORS

This file was deleted.

64 changes: 0 additions & 64 deletions bin/remark

This file was deleted.

Loading

0 comments on commit 8108fe5

Please sign in to comment.