Merge branch 'master' into lint
This commit is contained in:
commit
55ab987d44
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
test/* linguist-vendored
|
||||||
|
|
25
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
25
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- describe what the PR does -->
|
||||||
|
|
||||||
|
- Fixes ####
|
||||||
|
- Fixes list issues fixed by this PR
|
||||||
|
- Fixes will automatically close them once merged
|
||||||
|
|
||||||
|
## Review
|
||||||
|
|
||||||
|
### Submitter
|
||||||
|
|
||||||
|
- [ ] All tests pass (CI should take care of this, once in place).
|
||||||
|
- [ ] All lint checks pass (CI should take care of this, once in place).
|
||||||
|
- Tests
|
||||||
|
- [ ] Test(s) exist to ensure functionality works (if no new tests added, list which tests cover this functionality).
|
||||||
|
- [ ] No tests required for this PR.
|
||||||
|
- [ ] Is release:
|
||||||
|
- [ ] Version in `package.json` has been updated (see [RELEASE.md](https://github.com/markedjs/marked/blob/master/RELEASE.md)).
|
||||||
|
- [ ] The `marked.min.js` has been updated; or,
|
||||||
|
- [ ] release does not change library.
|
||||||
|
|
||||||
|
### Reviewer
|
||||||
|
|
||||||
|
??
|
27
RELEASE.md
Normal file
27
RELEASE.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
# Releasing Marked
|
||||||
|
|
||||||
|
**Master is always shippable:** We try to merge PRs in such a way that `master` is the only branch to really be concerned about *and* `master` can always be released. This allows smoother flow between new fetures, bug fixes, and so on. (Almost a continuous deployment setup, without automation.)
|
||||||
|
|
||||||
|
## Versioning
|
||||||
|
|
||||||
|
We follow [semantic versioning](https://semver.org) where the following sequence is true `[major].[minor].[patch]` (further, while in beta, you may see this `0.[major|minor].[minor|patch]`); therefore, consider the following implications of the release you are preparing:
|
||||||
|
|
||||||
|
1. **Major:** There is at least one change not deemed backward compatible. While in beta, the major will remain at zero; thereby, alerting consumers to the potentially volatile nature of the package.
|
||||||
|
2. **Minor:** There is at least one new feature added to the release. While in beta, the minor will tend to be more analagous to a `major` release. For example, we plan to release `0.4.0` once we have fixed most, if not all, known issues related to the CommonMark and GFM specifications because the architecture changes planned during `0.4.0` will most likely introduce breaking changes.
|
||||||
|
3. **Patch:** No breaking changes. Should fix a defect found in a feature. While in beta, the patch will tend to be more analagous to a `minor` release.
|
||||||
|
|
||||||
|
## Release process
|
||||||
|
|
||||||
|
- [ ] Fork `markedjs/marked` -> clone the library locally -> Make sure you are on the `master` branch
|
||||||
|
- [ ] Create release branch from `master` (`release-##.##.##`)
|
||||||
|
- `$ npm test` (run tests)
|
||||||
|
- `$ npm version [major|minor|patch]` (updates `package.json` and creates `min` file)
|
||||||
|
- `$ npm publish` (publish to NPM)
|
||||||
|
- [ ] Commit changes locally -> Submit PR to `origin/master` -> Merge PR
|
||||||
|
- `package.json` should, at minimum, have an updated version number.
|
||||||
|
- If the release contains changes to the library (most likely) you should also see a new `marked.min.js` file.
|
||||||
|
- [ ] Navigate to the "Releases" tab on the project main page -> "Draft new release"
|
||||||
|
- Add version number matching the one in the `package.json` file after publishing the release
|
||||||
|
- Make sure `master` is the branch from which the release will be made
|
||||||
|
- Add notes regarding what users should expect from the release
|
||||||
|
- Click "Publish release"
|
@ -467,7 +467,7 @@ var inline = {
|
|||||||
nolink: /^!?\[((?:\[[^\]]*\]|\\[\[\]]|[^\[\]])*)\]/,
|
nolink: /^!?\[((?:\[[^\]]*\]|\\[\[\]]|[^\[\]])*)\]/,
|
||||||
strong: /^__([\s\S]+?)__(?!_)|^\*\*([\s\S]+?)\*\*(?!\*)/,
|
strong: /^__([\s\S]+?)__(?!_)|^\*\*([\s\S]+?)\*\*(?!\*)/,
|
||||||
em: /^_([^\s_](?:[^_]|__)+?[^\s_])_\b|^\*((?:\*\*|[^*])+?)\*(?!\*)/,
|
em: /^_([^\s_](?:[^_]|__)+?[^\s_])_\b|^\*((?:\*\*|[^*])+?)\*(?!\*)/,
|
||||||
code: /^(`+)(\s*)([\s\S]*?[^`]?)\2\1(?!`)/,
|
code: /^(`+)\s*([\s\S]*?[^`]?)\s*\1(?!`)/,
|
||||||
br: /^ {2,}\n(?!\s*$)/,
|
br: /^ {2,}\n(?!\s*$)/,
|
||||||
del: noop,
|
del: noop,
|
||||||
text: /^[\s\S]+?(?=[\\<!\[`*]|\b_| {2,}\n|$)/
|
text: /^[\s\S]+?(?=[\\<!\[`*]|\b_| {2,}\n|$)/
|
||||||
@ -689,7 +689,7 @@ InlineLexer.prototype.output = function(src) {
|
|||||||
// code
|
// code
|
||||||
if (cap = this.rules.code.exec(src)) {
|
if (cap = this.rules.code.exec(src)) {
|
||||||
src = src.substring(cap[0].length);
|
src = src.substring(cap[0].length);
|
||||||
out += this.renderer.codespan(escape(cap[3].trim(), true));
|
out += this.renderer.codespan(escape(cap[2].trim(), true));
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
2
package-lock.json
generated
2
package-lock.json
generated
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "marked",
|
"name": "marked",
|
||||||
"version": "0.3.12",
|
"version": "0.3.15",
|
||||||
"lockfileVersion": 1,
|
"lockfileVersion": 1,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
11
package.json
11
package.json
@ -2,14 +2,14 @@
|
|||||||
"name": "marked",
|
"name": "marked",
|
||||||
"description": "A markdown parser built for speed",
|
"description": "A markdown parser built for speed",
|
||||||
"author": "Christopher Jeffrey",
|
"author": "Christopher Jeffrey",
|
||||||
"version": "0.3.12",
|
"version": "0.3.15",
|
||||||
"main": "./lib/marked.js",
|
"main": "./lib/marked.js",
|
||||||
"bin": "./bin/marked",
|
"bin": "./bin/marked",
|
||||||
"man": "./man/marked.1",
|
"man": "./man/marked.1",
|
||||||
"repository": "git://github.com/chjj/marked.git",
|
"repository": "git://github.com/markedjs/marked.git",
|
||||||
"homepage": "https://github.com/chjj/marked",
|
"homepage": "https://github.com/markedjs/marked",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "http://github.com/chjj/marked/issues"
|
"url": "http://github.com/markedjs/marked/issues"
|
||||||
},
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
@ -40,7 +40,8 @@
|
|||||||
"test": "node test",
|
"test": "node test",
|
||||||
"bench": "node test --bench",
|
"bench": "node test --bench",
|
||||||
"lint": "eslint --fix lib/marked.js test/index.js",
|
"lint": "eslint --fix lib/marked.js test/index.js",
|
||||||
"build": "uglifyjs lib/marked.js -cm --comments /Copyright/ -o marked.min.js"
|
"build": "uglifyjs lib/marked.js -cm --comments /Copyright/ -o marked.min.js",
|
||||||
|
"preversion": "npm run build"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=0.10.0"
|
"node": ">=0.10.0"
|
||||||
|
Loading…
x
Reference in New Issue
Block a user