chore: intial commit

travi · travi · commit 3f6d8d7cfd77 · 2020-04-17T00:45:16.000-05:00
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1 @@
+{"presets":["@form8ion"],"ignore":["./lib/"]}
diff --git a/.commitlintrc.js b/.commitlintrc.js
@@ -0,0 +1 @@
+module.exports = {extends: ['@form8ion']};
diff --git a/.czrc b/.czrc
@@ -0,0 +1 @@
+{"path":"./node_modules/cz-conventional-changelog"}
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,12 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+charset = utf-8
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,2 @@
+/lib/
+/coverage/
diff --git a/.eslintrc.yml b/.eslintrc.yml
@@ -0,0 +1,3 @@
+extends:
+  - '@form8ion'
+  - '@form8ion/mocha'
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto
diff --git a/.github/settings.yml b/.github/settings.yml
@@ -0,0 +1,6 @@
+_extends: .github
+repository:
+  name: remark-plugin-scaffolder
+  description: opinionated scaffolder for remark plugins
+  homepage: 'https://npm.im/@form8ion/remark-plugin-scaffolder'
+  private: false
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+/node_modules/
+/lib/
+/coverage/
+/.nyc_output/
+
+.eslintcache
diff --git a/.huskyrc.json b/.huskyrc.json
@@ -0,0 +1 @@
+{"hooks":{"pre-commit":"npm test","commit-msg":"commitlint -e"}}
diff --git a/.mocharc.json b/.mocharc.json
@@ -0,0 +1 @@
+{"ui":"tdd","require":["@babel/register","./test/mocha-setup.js"]}
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+update-notifier=false
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v12
diff --git a/.nycrc b/.nycrc
@@ -0,0 +1 @@
+{"reporter":["lcov","text-summary","html"],"exclude":["src/**/*-test.js","test/","thirdparty-wrappers/","vendor/"]}
diff --git a/.remarkrc.js b/.remarkrc.js
@@ -0,0 +1,14 @@
+// https://github.com/remarkjs/remark/tree/master/packages/remark-stringify#options
+exports.settings = {
+  listItemIndent: 1,
+  emphasis: '_',
+  strong: '_',
+  bullet: '*',
+  incrementListMarker: false
+};
+
+exports.plugins = [
+  '@form8ion/remark-lint-preset',
+  [require('remark-toc'), {tight: true}],
+  ['remark-usage', {heading: 'example'}]
+];
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,7 @@
+version: ~> 1.0
+notifications:
+  email: false
+import:
+  - source: 'form8ion/.travis-ci:node.yml'
+  - source: 'form8ion/.travis-ci:authenticated-semantic-release.yml'
+after_success: 'npm run coverage:report'
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,18 @@
+MIT License Copyright (c) 2020 Matt Travi
+
+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/README.md b/README.md
@@ -0,0 +1,101 @@
+# remark-plugin-scaffolder
+
+opinionated scaffolder for [remark](https://github.com/remarkjs/remark) [plugins](https://github.com/remarkjs/remark/blob/master/doc/plugins.md)
+
+<!--status-badges start -->
+
+[![Build Status][ci-badge]][ci-link]
+
+<!--status-badges end -->
+
+## Table of Contents
+
+* [Usage](#usage)
+  * [Installation](#installation)
+  * [Example](#example)
+* [Contributing](#contributing)
+  * [Dependencies](#dependencies)
+  * [Verification](#verification)
+
+## Usage
+
+<!--consumer-badges start -->
+
+[![MIT license][license-badge]][license-link]
+[![npm][npm-badge]][npm-link]
+[![Try @form8ion/remark-plugin-scaffolder on RunKit][runkit-badge]][runkit-link]
+
+<!--consumer-badges end -->
+
+### Installation
+
+```sh
+$ npm install @form8ion/remark-plugin-scaffolder --save-prod
+```
+
+### Example
+
+```javascript
+import remarkPluginScaffolder from '@form8ion/remark-plugin-scaffolder';
+```
+
+## Contributing
+
+<!--contribution-badges start -->
+
+[![PRs Welcome][PRs-badge]][PRs-link]
+[![Conventional Commits][commit-convention-badge]][commit-convention-link]
+[![Commitizen friendly][commitizen-badge]][commitizen-link]
+[![semantic-release][semantic-release-badge]][semantic-release-link]
+[![Renovate][renovate-badge]][renovate-link]
+
+<!--contribution-badges end -->
+
+### Dependencies
+
+```sh
+$ nvm install
+$ npm install
+```
+
+### Verification
+
+```sh
+$ npm test
+```
+
+[PRs-link]: http://makeapullrequest.com
+
+[PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
+
+[commit-convention-link]: https://conventionalcommits.org
+
+[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
+
+[commitizen-link]: http://commitizen.github.io/cz-cli/
+
+[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
+
+[semantic-release-link]: https://github.com/semantic-release/semantic-release
+
+[semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
+
+[renovate-link]: https://renovatebot.com
+
+[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAzNjkgMzY5Ij48Y2lyY2xlIGN4PSIxODkuOSIgY3k9IjE5MC4yIiByPSIxODQuNSIgZmlsbD0iI2ZmZTQyZSIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoLTUgLTYpIi8+PHBhdGggZmlsbD0iIzhiYjViNSIgZD0iTTI1MSAyNTZsLTM4LTM4YTE3IDE3IDAgMDEwLTI0bDU2LTU2YzItMiAyLTYgMC03bC0yMC0yMWE1IDUgMCAwMC03IDBsLTEzIDEyLTktOCAxMy0xM2ExNyAxNyAwIDAxMjQgMGwyMSAyMWM3IDcgNyAxNyAwIDI0bC01NiA1N2E1IDUgMCAwMDAgN2wzOCAzOHoiLz48cGF0aCBmaWxsPSIjZDk1NjEyIiBkPSJNMzAwIDI4OGwtOCA4Yy00IDQtMTEgNC0xNiAwbC00Ni00NmMtNS01LTUtMTIgMC0xNmw4LThjNC00IDExLTQgMTUgMGw0NyA0N2M0IDQgNCAxMSAwIDE1eiIvPjxwYXRoIGZpbGw9IiMyNGJmYmUiIGQ9Ik04MSAxODVsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzI1YzRjMyIgZD0iTTIyMCAxMDBsMjMgMjNjNCA0IDQgMTEgMCAxNkwxNDIgMjQwYy00IDQtMTEgNC0xNSAwbC0yNC0yNGMtNC00LTQtMTEgMC0xNWwxMDEtMTAxYzUtNSAxMi01IDE2IDB6Ii8+PHBhdGggZmlsbD0iIzFkZGVkZCIgZD0iTTk5IDE2N2wxOC0xOCAxOCAxOC0xOCAxOHoiLz48cGF0aCBmaWxsPSIjMDBhZmIzIiBkPSJNMjMwIDExMGwxMyAxM2M0IDQgNCAxMSAwIDE2TDE0MiAyNDBjLTQgNC0xMSA0LTE1IDBsLTEzLTEzYzQgNCAxMSA0IDE1IDBsMTAxLTEwMWM1LTUgNS0xMSAwLTE2eiIvPjxwYXRoIGZpbGw9IiMyNGJmYmUiIGQ9Ik0xMTYgMTQ5bDE4LTE4IDE4IDE4LTE4IDE4eiIvPjxwYXRoIGZpbGw9IiMxZGRlZGQiIGQ9Ik0xMzQgMTMxbDE4LTE4IDE4IDE4LTE4IDE4eiIvPjxwYXRoIGZpbGw9IiMxYmNmY2UiIGQ9Ik0xNTIgMTEzbDE4LTE4IDE4IDE4LTE4IDE4eiIvPjxwYXRoIGZpbGw9IiMyNGJmYmUiIGQ9Ik0xNzAgOTVsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzFiY2ZjZSIgZD0iTTYzIDE2N2wxOC0xOCAxOCAxOC0xOCAxOHpNOTggMTMxbDE4LTE4IDE4IDE4LTE4IDE4eiIvPjxwYXRoIGZpbGw9IiMzNGVkZWIiIGQ9Ik0xMzQgOTVsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzFiY2ZjZSIgZD0iTTE1MyA3OGwxOC0xOCAxOCAxOC0xOCAxOHoiLz48cGF0aCBmaWxsPSIjMzRlZGViIiBkPSJNODAgMTEzbDE4LTE3IDE4IDE3LTE4IDE4ek0xMzUgNjBsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzk4ZWRlYiIgZD0iTTI3IDEzMWwxOC0xOCAxOCAxOC0xOCAxOHoiLz48cGF0aCBmaWxsPSIjYjUzZTAyIiBkPSJNMjg1IDI1OGw3IDdjNCA0IDQgMTEgMCAxNWwtOCA4Yy00IDQtMTEgNC0xNiAwbC02LTdjNCA1IDExIDUgMTUgMGw4LTdjNC01IDQtMTIgMC0xNnoiLz48cGF0aCBmaWxsPSIjOThlZGViIiBkPSJNODEgNzhsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzAwYTNhMiIgZD0iTTIzNSAxMTVsOCA4YzQgNCA0IDExIDAgMTZMMTQyIDI0MGMtNCA0LTExIDQtMTUgMGwtOS05YzUgNSAxMiA1IDE2IDBsMTAxLTEwMWM0LTQgNC0xMSAwLTE1eiIvPjxwYXRoIGZpbGw9IiMzOWQ5ZDgiIGQ9Ik0yMjggMTA4bC04LThjLTQtNS0xMS01LTE2IDBMMTAzIDIwMWMtNCA0LTQgMTEgMCAxNWw4IDhjLTQtNC00LTExIDAtMTVsMTAxLTEwMWM1LTQgMTItNCAxNiAweiIvPjxwYXRoIGZpbGw9IiNhMzM5MDQiIGQ9Ik0yOTEgMjY0bDggOGM0IDQgNCAxMSAwIDE2bC04IDdjLTQgNS0xMSA1LTE1IDBsLTktOGM1IDUgMTIgNSAxNiAwbDgtOGM0LTQgNC0xMSAwLTE1eiIvPjxwYXRoIGZpbGw9IiNlYjZlMmQiIGQ9Ik0yNjAgMjMzbC00LTRjLTYtNi0xNy02LTIzIDAtNyA3LTcgMTcgMCAyNGw0IDRjLTQtNS00LTExIDAtMTZsOC04YzQtNCAxMS00IDE1IDB6Ii8+PHBhdGggZmlsbD0iIzEzYWNiZCIgZD0iTTEzNCAyNDhjLTQgMC04LTItMTEtNWwtMjMtMjNhMTYgMTYgMCAwMTAtMjNMMjAxIDk2YTE2IDE2IDAgMDEyMiAwbDI0IDI0YzYgNiA2IDE2IDAgMjJMMTQ2IDI0M2MtMyAzLTcgNS0xMiA1em03OC0xNDdsLTQgMi0xMDEgMTAxYTYgNiAwIDAwMCA5bDIzIDIzYTYgNiAwIDAwOSAwbDEwMS0xMDFhNiA2IDAgMDAwLTlsLTI0LTIzLTQtMnoiLz48cGF0aCBmaWxsPSIjYmY0NDA0IiBkPSJNMjg0IDMwNGMtNCAwLTgtMS0xMS00bC00Ny00N2MtNi02LTYtMTYgMC0yMmw4LThjNi02IDE2LTYgMjIgMGw0NyA0NmM2IDcgNiAxNyAwIDIzbC04IDhjLTMgMy03IDQtMTEgNHptLTM5LTc2Yy0xIDAtMyAwLTQgMmwtOCA3Yy0yIDMtMiA3IDAgOWw0NyA0N2E2IDYgMCAwMDkgMGw3LThjMy0yIDMtNiAwLTlsLTQ2LTQ2Yy0yLTItMy0yLTUtMnoiLz48L3N2Zz4=
+
+[ci-link]: https://travis-ci.com/form8ion/remark-plugin-scaffolder
+
+[ci-badge]: https://img.shields.io/travis/com/form8ion/remark-plugin-scaffolder/master.svg
+
+[license-link]: LICENSE
+
+[license-badge]: https://img.shields.io/github/license/form8ion/remark-plugin-scaffolder.svg
+
+[npm-link]: https://www.npmjs.com/package/@form8ion/remark-plugin-scaffolder
+
+[npm-badge]: https://img.shields.io/npm/v/@form8ion/remark-plugin-scaffolder.svg
+
+[runkit-link]: https://npm.runkit.com/@form8ion/remark-plugin-scaffolder
+
+[runkit-badge]: https://badge.runkitcdn.com/@form8ion/remark-plugin-scaffolder.svg
diff --git a/example.js b/example.js
@@ -0,0 +1,3 @@
+// remark-usage-ignore-next
+/* eslint-disable-next-line no-unused-vars */
+import remarkPluginScaffolder from './lib/index.cjs';
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/renovate.json b/renovate.json
diff --git a/rollup.config.js b/rollup.config.js
diff --git a/src/canary-test.js b/src/canary-test.js
diff --git a/src/index.js b/src/index.js
diff --git a/test/mocha-setup.js b/test/mocha-setup.js

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"presets":["@form8ion"],"ignore":["./lib/"]}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+module.exports = {extends: ['@form8ion']};`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"path":"./node_modules/cz-conventional-changelog"}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+extends:`
	`2`	`+ - '@form8ion'`
	`3`	`+ - '@form8ion/mocha'`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"hooks":{"pre-commit":"npm test","commit-msg":"commitlint -e"}}`