feat: allow hljs to be run from command line #1951
Merged
Conversation
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 allows the ability for hljs's build script to be run from the command line. This is useful for sofware that requires hljs as part of a build chain. It disables generation of docs and demo by default. The patch adds the following options to "tools/build.js": * `--output`: path to write build files to. Defaults to "build". * `--docs`: tells builder to include the docs and demo. Build just for Web, don't include docs: ```Bash hljs --output "some/path xml" javascript ``` Build for Web, include docs: ```Bash hljs --docs --output "some/path" xml javascript ``` Build for NodeJS: ```Bash hljs -t node --output "some/path" xml javascript ``` Build for everything: ```Bash hljs -t all --output "some/path" xml javascript ```
egor-rogov
approved these changes
Jan 31, 2019
There was a problem hiding this comment.
Looks good.
Documentation probably needs to be updated accordingly in building-testing.rst.
By the way, documentation on https://highlightjs.readthedocs.io/ is outdated (pre-9.13).
|
Good point about the docs. I'll add some documentation before merging. |
|
@egor-rogov any idea how we would update https://highlightjs.readthedocs.io/ ? |
Hmm, I thought you have access to upload fresh docs, no? |
fengmk2
reviewed
Feb 25, 2019
| @@ -21,6 +21,9 @@ | |||
| "url": "git://github.com/highlightjs/highlight.js.git" | |||
| }, | |||
| "main": "./lib/index.js", | |||
| "bin": { | |||
| "hljs": "./tools/build.js" | |||
There was a problem hiding this comment.
missing tools/build.js file on npm package. #1984
marcoscaceres
pushed a commit
that referenced
this pull request
Feb 25, 2019
This reverts commit ee2ae80.
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This allows the ability for hljs's build script to be run from
the command line.
This is useful for sofware that requires hljs as part of a build
chain.
It disables generation of docs and demo by default.
The patch adds the following options to "tools/build.js":
--output: path to write build files to. Defaults to "build".--docs: tells builder to include the docs and demo.Build just for Web, don't include docs:
hljs --output "some/path xml" javascriptBuild for Web, include docs:
hljs --docs --output "some/path" xml javascriptBuild for NodeJS:
hljs -t node --output "some/path" xml javascriptBuild for everything:
hljs -t all --output "some/path" xml javascript