Switch to remark-cli to support .remarkrc and unlock remark version #2008
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,62 @@ | ||
| ### | ||
| Requires https://github.com/remarkjs/remark | ||
| ### | ||
| "use strict" | ||
| Beautifier = require('./beautifier') | ||
|
|
||
| module.exports = class Remark extends Beautifier | ||
| name: "Remark" | ||
| link: "https://github.com/remarkjs/remark" | ||
|
There was a problem hiding this comment. The project has been moved to an org in ≈ Dec 2017 |
||
| options: { | ||
| _: { | ||
| gfm: true | ||
| yaml: true | ||
| commonmark: true | ||
| search_for_configuration: true | ||
| } | ||
| Markdown: true | ||
| } | ||
|
|
||
| executables: [ | ||
| { | ||
| name: "Remark CLI" | ||
| cmd: "remark" | ||
| homepage: "https://github.com/remarkjs/remark" | ||
| installation: "https://github.com/remarkjs/remark/tree/master/packages/remark-cli#installation" | ||
| version: { | ||
| parse: (text) -> | ||
| return text.match(/remark: (\d+\.\d+\.\d+)/)[1] | ||
| runOptions: { | ||
| returnStderr: true | ||
| } | ||
| } | ||
| } | ||
| ] | ||
|
|
||
| beautify: (text, language, options, context) -> | ||
| cwd = context.filePath and path.dirname context.filePath | ||
| remarkArgs = [ | ||
| '--no-color' | ||
| '--no-ignore' | ||
| '--file-path' | ||
| context.filePath | ||
| ] | ||
| remarkOptions = {} | ||
|
|
||
| if (!options.search_for_configuration) | ||
| settings = Object.assign({}, options) | ||
| delete settings.search_for_configuration | ||
| serializedSettings = JSON.stringify(settings).slice(1, -1) | ||
| remarkArgs.push('--no-config', '--setting', serializedSettings) | ||
|
|
||
| return new Promise((resolve, reject) => | ||
|
There was a problem hiding this comment. A new promise object is not really necessary here at this point, but it is helpful to integrate the new implementation of the beautifier with #1990 |
||
| @exe("remark") | ||
| .run(remarkArgs, { | ||
| cwd | ||
| onStdin: (stdin) -> | ||
| stdin.end text | ||
| }) | ||
| .then (output) -> | ||
| resolve(output) | ||
| .catch(reject) | ||
| ) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kachkaev @szeck87 : I think we can support both Remark-CLI and be backwards compatible with
remarkas a Node.js dependency.Since the
Remark CLIis now an Executable we should be able to determine if it is installed or not.See
atom-beautify/src/beautifiers/executable.coffee
Lines 99 to 107 in 30dece2
I'm thinking something along the lines of:
I would prefer to add new features while being backwards compatible. Removable of
remarkas a builtin dependency is considered a breaking change to me. However, there is value in usingRemark CLIdirectly 👍, such as the configuration file.