fix(deps): bump remark-cli from 11.0.0 to 12.0.0 #1617
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
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=60&v=4){kind=small}
dependabot
bot
added
dependencies
Diff between remark-cli 11.0.0 and 12.0.0diff --git a/license b/license
index v11.0.0..v12.0.0 100644
--- a/license
+++ b/license
@@ -1,6 +1,5 @@
(The MIT License)
-Copyright (c) 2014-2020 Titus Wormer <tituswormer@gmail.com>
-Copyright (c) 2011-2014, Christopher Jeffrey (https://github.com/chjj/)
+Copyright (c) 2014 Titus Wormer <tituswormer@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
diff --git a/cli.js b/cli.js
index v11.0.0..v12.0.0 100755
--- a/cli.js
+++ b/cli.js
@@ -1,36 +1,43 @@
#!/usr/bin/env node
-import {createRequire} from 'node:module'
+
+/**
+ * @typedef Pack
+ * @property {string} name
+ * @property {string} version
+ * @property {string} description
+ */
+
+import fs from 'node:fs/promises'
+import {resolve} from 'import-meta-resolve'
+import markdownExtensions from 'markdown-extensions'
+import {remark} from 'remark'
import {args} from 'unified-args'
-import {remark} from 'remark'
-const require = createRequire(import.meta.url)
+/** @type {Pack} */
+const proc = JSON.parse(
+ String(
+ await fs.readFile(
+ new URL('package.json', resolve('remark', import.meta.url))
+ )
+ )
+)
-const proc = require('remark/package.json')
-const cli = require('./package.json')
+/** @type {Pack} */
+const cli = JSON.parse(
+ String(await fs.readFile(new URL('package.json', import.meta.url)))
+)
-// To do: enable `markdown-extensions` once it supports ESM.
-const extensions = [
- 'md',
- 'markdown',
- 'mdown',
- 'mkdn',
- 'mkd',
- 'mdwn',
- 'mkdown',
- 'ron'
-]
-
args({
+ description: cli.description,
+ extensions: markdownExtensions,
+ ignoreName: '.' + proc.name + 'ignore',
+ name: proc.name,
+ packageField: proc.name + 'Config',
+ pluginPrefix: proc.name,
processor: remark,
- name: proc.name,
- description: cli.description,
+ rcName: '.' + proc.name + 'rc',
version: [
proc.name + ': ' + proc.version,
cli.name + ': ' + cli.version
- ].join(', '),
- pluginPrefix: proc.name,
- packageField: proc.name + 'Config',
- rcName: '.' + proc.name + 'rc',
- ignoreName: '.' + proc.name + 'ignore',
- extensions
+ ].join(', ')
})
diff --git a/package.json b/package.json
index v11.0.0..v12.0.0 100644
--- a/package.json
+++ b/package.json
@@ -1,14 +1,14 @@
{
"name": "remark-cli",
- "version": "11.0.0",
- "description": "Command line interface to inspect and change markdown files with remark",
+ "version": "12.0.0",
+ "description": "CLI to process markdown with remark",
"license": "MIT",
"keywords": [
- "unified",
- "remark",
+ "bin",
+ "cli",
"markdown",
"mdast",
- "cli",
- "bin"
+ "remark",
+ "unified"
],
"homepage": "https://remark.js.org",
@@ -24,5 +24,5 @@
],
"type": "module",
- "main": "index.js",
+ "exports": [],
"bin": {
"remark": "cli.js"
@@ -32,17 +32,18 @@
],
"dependencies": {
- "remark": "^14.0.0",
- "unified-args": "^10.0.0"
+ "import-meta-resolve": "^3.0.0",
+ "markdown-extensions": "^2.0.0",
+ "remark": "^15.0.0",
+ "unified-args": "^11.0.0"
},
- "scripts": {
- "build": "rimraf \"*.d.ts\" && tsc && type-coverage",
- "test": "node --conditions development test.js"
- },
- "xo": false,
+ "scripts": {},
"typeCoverage": {
"atLeast": 100,
"detail": true,
- "strict": true,
- "ignoreCatch": true
+ "ignoreCatch": true,
+ "strict": true
+ },
+ "xo": {
+ "prettier": true
}
}
diff --git a/readme.md b/readme.md
index v11.0.0..v12.0.0 100644
--- a/readme.md
+++ b/readme.md
@@ -30,8 +30,7 @@
This package is a command line interface (CLI) that you can use in your terminal
or in npm scripts and the like to inspect and change markdown files.
-This CLI is built around remark, which is a very popular ecosystem of plugins
-that work with markdown as structured data, specifically ASTs (abstract syntax
-trees).
-You can choose from the 150+ plugins that already exist or make your own.
+This CLI is built around remark, which is an ecosystem of plugins that work with
+markdown as structured data, specifically ASTs (abstract syntax trees).
+You can choose from the 150+ existing plugins or make your own.
See [the monorepo readme][remark] for info on what the remark ecosystem is.
@@ -47,6 +46,6 @@
## Install
-This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
-In Node.js (version 14.14+, or 16.0+), install with [npm][]:
+This package is [ESM only][esm].
+In Node.js (version 16+), install with [npm][]:
```sh
@@ -59,5 +58,5 @@
```sh
-remark readme.md --use remark-toc --output
+remark readme.md --output --use remark-toc
```
@@ -81,29 +80,30 @@
Options:
+ --[no-]color specify color in report (on by default)
+ --[no-]config search for configuration files (on by default)
+ -e --ext <extensions> specify extensions
+ --file-path <path> specify path to process as
+ -f --frail exit with 1 on warnings
-h --help output usage information
- -v --version output version number
+ --[no-]ignore search for ignore files (on by default)
+ -i --ignore-path <path> specify ignore file
+ --ignore-path-resolve-from cwd|dir resolve patterns in `ignore-path` from its directory or cwd
+ --ignore-pattern <globs> specify ignore patterns
+ --inspect output formatted syntax tree
-o --output [path] specify output location
+ -q --quiet output only warnings and errors
-r --rc-path <path> specify configuration file
- -i --ignore-path <path> specify ignore file
+ --report <reporter> specify reporter
-s --setting <settings> specify settings
- -e --ext <extensions> specify extensions
- -u --use <plugins> use plugins
- -w --watch watch for changes and reprocess
- -q --quiet output only warnings and errors
-S --silent output only errors
- -f --frail exit with 1 on warnings
+ --silently-ignore do not fail when given ignored files
+ --[no-]stdout specify writing to stdout (on by default)
-t --tree specify input and output as syntax tree
- --report <reporter> specify reporter
- --file-path <path> specify path to process as
- --ignore-path-resolve-from dir|cwd resolve patterns in `ignore-path` from its directory or cwd
- --ignore-pattern <globs> specify ignore patterns
- --silently-ignore do not fail when given ignored files
--tree-in specify input as syntax tree
--tree-out output syntax tree
- --inspect output formatted syntax tree
- --[no-]stdout specify writing to stdout (on by default)
- --[no-]color specify color in report (on by default)
- --[no-]config search for configuration files (on by default)
- --[no-]ignore search for ignore files (on by default)
+ -u --use <plugins> use plugins
+ --verbose report extra info for messages
+ -v --version output version number
+ -w --watch watch for changes and reprocess
Examples:
@@ -119,15 +119,15 @@
```
-More information on all these options is available at
-[`unified-args`][unified-args], which does the work.
+More info on all these options is available at [`unified-args`][unified-args],
+which does the work.
`remark-cli` is `unified-args` preconfigured to:
-* Load `remark-` plugins
-* Search for markdown extensions
+* load `remark-` plugins
+* search for markdown extensions
([`.md`, `.markdown`, etc][markdown-extensions])
-* Ignore paths found in [`.remarkignore` files][ignore-file]
-* Load configuration from
+* ignore paths found in [`.remarkignore` files][ignore-file]
+* load configuration from
[`.remarkrc`, `.remarkrc.js`, etc files][config-file]
-* Use configuration from
+* use configuration from
[`remarkConfig` fields in `package.json` files][config-file]
@@ -139,11 +139,11 @@
It assumes you’re in a Node.js package.
-First, install the CLI and plugins:
+Install the CLI and plugins:
```sh
-npm install remark-cli remark-toc remark-preset-lint-consistent remark-preset-lint-recommended --save-dev
+npm install remark-cli remark-preset-lint-consistent remark-preset-lint-recommended remark-toc --save-dev
```
-Now, add an npm script in your `package.json`:
+…then add an npm script in your `package.json`:
```js
@@ -159,5 +159,5 @@
> 💡 **Tip**: add ESLint and such in the `format` script too.
-Observe that the above change adds a `format` script, which can be run with
+The above change adds a `format` script, which can be run with
`npm run format`.
It runs remark on all markdown files (`.`) and rewrites them (`--output`).
@@ -189,5 +189,5 @@
> 👉 **Note**: you must remove the comments in the above examples when
-> copy/pasting them, as comments are not supported in `package.json` files.
+> copy/pasting them as comments are not supported in `package.json` files.
Finally, you can run the npm script to check and format markdown files in your
@@ -270,8 +270,8 @@
1. `.remarkrc` (JSON)
+3. `.remarkrc.cjs` (CJS)
+5. `.remarkrc.js` (CJS or ESM, depending on `type: 'module'` in `package.json`)
2. `.remarkrc.json` (JSON)
-3. `.remarkrc.cjs` (CJS)
4. `.remarkrc.mjs` (ESM)
-5. `.remarkrc.js` (CJS or ESM, depending on `type: 'module'` in `package.json`)
6. `.remarkrc.yaml` (YAML)
7. `.remarkrc.yml` (YAML)
@@ -280,9 +280,12 @@
## Compatibility
-Projects maintained by the unified collective are compatible with all maintained
+Projects maintained by the unified collective are compatible with maintained
versions of Node.js.
-As of now, that is Node.js 14.14+, and 16.0+.
-Our projects sometimes work with older versions, but this is not guaranteed.
+When we cut a new major release, we drop support for unmaintained versions of
+Node.
+This means we try to keep the current release line, `remark-cli@^12`,
+compatible with Node.js 16.
+
## Security
@@ -312,6 +315,4 @@
Support this effort and give back by sponsoring on [OpenCollective][collective]!
-<!--lint ignore no-html-->
-
<table>
<tr valign="middle">
@@ -362,4 +363,8 @@
</td>
<td width="10%" align="center">
+ <a href="https://markdown.space">Markdown Space</a><br><br>
+ <a href="https://markdown.space"><img src="https://images.opencollective.com/markdown-space/e1038ed/logo/128.png" width="64"></a>
+</td>
+<td width="10%" align="center">
<a href="https://www.holloway.com">Holloway</a><br><br>
<a href="https://www.holloway.com"><img src="https://avatars1.githubusercontent.com/u/35904294?s=128&v=4" width="64"></a>
@@ -367,5 +372,4 @@
<td width="10%"></td>
<td width="10%"></td>
-<td width="10%"></td>
</tr>
<tr valign="middle">
@@ -422,6 +426,8 @@
[npm]: https://docs.npmjs.com/cli/install
-[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+[markdown-extensions]: https://github.com/sindresorhus/markdown-extensions
+
[rehype]: https://github.com/rehypejs/rehype
@@ -430,15 +436,15 @@
[remark]: https://github.com/remarkjs/remark
-[markdown-extensions]: https://github.com/sindresorhus/markdown-extensions
+[remark-core]: ../remark/
-[config-file]: https://github.com/unifiedjs/unified-engine/blob/main/doc/configure.md
+[remark-toc]: https://github.com/remarkjs/remark-toc
-[ignore-file]: https://github.com/unifiedjs/unified-engine/blob/main/doc/ignore.md
+[config-file]: https://github.com/unifiedjs/unified-engine#config-files
+[ignore-file]: https://github.com/unifiedjs/unified-engine#ignore-files
+
[unified-args]: https://github.com/unifiedjs/unified-args#cli
-[remark-core]: ../remark
+[markdown-style-guide]: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-preset-lint-markdown-style-guide
-[remark-toc]: https://github.com/remarkjs/remark-toc
-
-[markdown-style-guide]: https://github.com/remarkjs/remark-lint/tree/main/packages/remark-preset-lint-markdown-style-guide
+[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
Command detailsnpm diff --diff=remark-cli@11.0.0 --diff=remark-cli@12.0.0 --diff-unified=2See also the Reported by ybiquitous/npm-diff-action@v1.5.0 (Node.js 20.7.0 and npm 10.1.0) |
dependabot
bot
force-pushed
the
dependabot/npm_and_yarn/remark-cli-12.0.0
branch
4 times, most recently
from
1c291e8
to
9db6c92
Compare
ybiquitous
changed the title
Bumps [remark-cli](https://github.com/remarkjs/remark) from 11.0.0 to 12.0.0. - [Release notes](https://github.com/remarkjs/remark/releases) - [Changelog](https://github.com/remarkjs/remark/blob/main/changelog.md) - [Commits](https://github.com/remarkjs/remark/compare/remark-cli@11.0.0...remark-cli@12.0.0) --- updated-dependencies: - dependency-name: remark-cli dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
dependabot
bot
force-pushed
the
dependabot/npm_and_yarn/remark-cli-12.0.0
branch
from
9db6c92
to
b85bdc6
Compare
|
Closes #1624 |
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.
Bumps remark-cli from 11.0.0 to 12.0.0.
Release notes
Sourced from remark-cli's releases.
Commits
d993c7fremark-cli: 12.0.0516a5d115.0.051e094eremark-stringify: 11.0.0de740c7remark-parse: 11.0.01a769ddFix TS generating broken definitions98a2560Change to require Node.js 16350645aFix license6a43da8Refactor docsc348aecRefactor some metadataa3e6d54Change to useexportsDependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebasewill rebase this PR@dependabot recreatewill recreate this PR, overwriting any edits that have been made to it@dependabot mergewill merge this PR after your CI passes on it@dependabot squash and mergewill squash and merge this PR after your CI passes on it@dependabot cancel mergewill cancel a previously requested merge and block automerging@dependabot reopenwill reopen this PR if it is closed@dependabot closewill close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot show <dependency name> ignore conditionswill show all of the ignore conditions of the specified dependency@dependabot ignore this major versionwill close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor versionwill close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependencywill close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)