diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index c6c8b36..0000000 --- a/.editorconfig +++ /dev/null @@ -1,9 +0,0 @@ -root = true - -[*] -indent_style = space -indent_size = 2 -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true diff --git a/.github/workflows/bb.yml b/.github/workflows/bb.yml deleted file mode 100644 index 0198fc3..0000000 --- a/.github/workflows/bb.yml +++ /dev/null @@ -1,13 +0,0 @@ -name: bb -on: - issues: - types: [opened, reopened, edited, closed, labeled, unlabeled] - pull_request_target: - types: [opened, reopened, edited, closed, labeled, unlabeled] -jobs: - main: - runs-on: ubuntu-latest - steps: - - uses: unifiedjs/beep-boop-beta@main - with: - repo-token: ${{secrets.GITHUB_TOKEN}} diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml deleted file mode 100644 index fe284ad..0000000 --- a/.github/workflows/main.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: main -on: - - pull_request - - push -jobs: - main: - name: ${{matrix.node}} - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - uses: dcodeIO/setup-node-nvm@master - with: - node-version: ${{matrix.node}} - - run: npm install - - run: npm test - - uses: codecov/codecov-action@v1 - strategy: - matrix: - node: - - lts/erbium - - node diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 53a29e3..0000000 --- a/.gitignore +++ /dev/null @@ -1,6 +0,0 @@ -coverage/ -node_modules/ -.DS_Store -*.d.ts -*.log -yarn.lock diff --git a/.npmrc b/.npmrc deleted file mode 100644 index 43c97e7..0000000 --- a/.npmrc +++ /dev/null @@ -1 +0,0 @@ -package-lock=false diff --git a/.prettierignore b/.prettierignore deleted file mode 100644 index e7939c4..0000000 --- a/.prettierignore +++ /dev/null @@ -1,3 +0,0 @@ -coverage/ -*.json -*.md diff --git a/index.js b/index.js deleted file mode 100644 index bb20492..0000000 --- a/index.js +++ /dev/null @@ -1,11 +0,0 @@ -import {gulpEngine} from 'unified-engine-gulp' -import {remark as processor} from 'remark' - -export const remark = gulpEngine({ - processor, - name: 'gulp-remark', - pluginPrefix: 'remark', - packageField: 'remarkConfig', - rcName: '.remarkrc', - ignoreName: '.remarkignore' -}) diff --git a/license b/license deleted file mode 100644 index 24617c6..0000000 --- a/license +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright (c) 2015 Denys Dovhan - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -'Software'), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/package.json b/package.json index de3fba5..2519922 100644 --- a/package.json +++ b/package.json @@ -1,71 +1,6 @@ { + "bugs": "https://github.com/remarkjs/gulp-remark/issues", "name": "gulp-remark", - "version": "10.0.1", - "description": "Legacy gulp plugin for remark — please use alternatives to Gulp such as npm scripts instead", - "license": "MIT", - "keywords": [], "repository": "remarkjs/gulp-remark", - "bugs": "https://github.com/remarkjs/gulp-remark/issues", - "author": "Denys Dovhan (https://denysdovhan.com)", - "contributors": [ - "Denys Dovhan (https://denysdovhan.com)", - "Titus Wormer (https://wooorm.com)", - "Margatroid " - ], - "sideEffects": false, - "type": "module", - "main": "index.js", - "types": "index.d.ts", - "files": [ - "index.d.ts", - "index.js" - ], - "dependencies": { - "remark": "^14.0.0", - "unified-engine-gulp": "^9.0.0" - }, - "devDependencies": { - "@types/tape": "^4.0.0", - "c8": "^7.0.0", - "plugin-error": "^1.0.0", - "prettier": "^2.0.0", - "remark-cli": "^10.0.0", - "remark-html": "^15.0.0", - "remark-preset-wooorm": "^9.0.0", - "rimraf": "^3.0.0", - "tape": "^5.0.0", - "type-coverage": "^2.0.0", - "typescript": "^4.0.0", - "vinyl": "^2.0.0", - "xo": "^0.46.0" - }, - "scripts": { - "build": "rimraf \"*.d.ts\" && tsc && type-coverage", - "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix", - "test-api": "node --conditions development test.js", - "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov npm run test-api", - "test": "npm run build && npm run format && npm run test-coverage" - }, - "prettier": { - "tabWidth": 2, - "useTabs": false, - "singleQuote": true, - "bracketSpacing": false, - "semi": false, - "trailingComma": "none" - }, - "xo": { - "prettier": true - }, - "remarkConfig": { - "plugins": [ - "preset-wooorm" - ] - }, - "typeCoverage": { - "atLeast": 100, - "detail": true, - "strict": true, - "ignoreCatch": true - } + "version": "11.0.0" } diff --git a/readme.md b/readme.md index 0143882..29e7710 100644 --- a/readme.md +++ b/readme.md @@ -1,21 +1,7 @@ # gulp-remark -**Stability: Legacy**. -This package is no longer recommended for use. -It’s still covered by semantic-versioning guarantees and not yet deprecated, but -use of this package should be avoided. -Please use an alternative to Gulp such as npm scripts instead. +Deprecated: this package was not used enough to warrant continued maintenance. -Legacy [documentation for this package][docs] is still available in Git. +[Git][] is still intact and previous versions can still be used without warnings. -## License - -[MIT][license] © [Denys Dovhan][author] - - - -[license]: license - -[author]: https://denysdovhan.com - -[docs]: https://github.com/remarkjs/gulp-remark/tree/0676fdd +[git]: https://github.com/remarkjs/gulp-remark/tree/b856c01 diff --git a/test.js b/test.js deleted file mode 100644 index 07f9519..0000000 --- a/test.js +++ /dev/null @@ -1,84 +0,0 @@ -import {Buffer} from 'node:buffer' -import {PassThrough} from 'node:stream' -import PluginError from 'plugin-error' -import Vinyl from 'vinyl' -import test from 'tape' -import remarkHtml from 'remark-html' -import {remark} from './index.js' - -const fixture = new Vinyl({ - path: 'fixture.txt', - contents: Buffer.from('_italic_, **bold**.') -}) - -const commonmarkFixture = new Vinyl({ - path: 'fixture-commonmark.txt', - contents: Buffer.from('1) List in commonmark') -}) - -test('gulp-remark', (t) => { - t.test('should not do anything', (t) => { - t.plan(2) - - const stream = remark({silent: true}) - stream.write(fixture) - - stream.once('data', (/** @type {Vinyl} */ file) => { - t.equal(file.relative, 'fixture.txt') - t.equal(String(file.contents), '*italic*, **bold**.\n') - }) - }) - - t.test('should support settings', (t) => { - const stream = remark({settings: {commonmark: true}, silent: true}).use( - remarkHtml - ) - - t.plan(2) - - stream.write(commonmarkFixture) - - stream.once('data', (/** @type {Vinyl} */ file) => { - t.equal(file.relative, 'fixture-commonmark.txt') - t.equal( - String(file.contents), - '
    \n
  1. List in commonmark
    2. \n
\n' - ) - }) - }) - - t.test('should use plugins', (t) => { - const stream = remark({silent: true}).use(remarkHtml) - - t.plan(2) - - stream.write(fixture) - - stream.once('data', (/** @type {Vinyl} */ file) => { - t.equal(file.relative, 'fixture.txt') - t.equal( - String(file.contents), - '

italic, bold.

\n' - ) - }) - }) - - t.test('should throw PluginError with streams', (t) => { - const inStream = new PassThrough() - - const outStream = new Vinyl({contents: inStream}) - - t.throws(write, PluginError) - - t.end() - - function write() { - inStream.write('_italic_') - inStream.write('**bold**') - inStream.write('.') - remark({}).write(outStream) - } - }) - - t.end() -}) diff --git a/tsconfig.json b/tsconfig.json deleted file mode 100644 index e31adf8..0000000 --- a/tsconfig.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "include": ["*.js"], - "compilerOptions": { - "target": "ES2020", - "lib": ["ES2020"], - "module": "ES2020", - "moduleResolution": "node", - "allowJs": true, - "checkJs": true, - "declaration": true, - "emitDeclarationOnly": true, - "allowSyntheticDefaultImports": true, - "skipLibCheck": true, - "strict": true - } -}