Add contents

Author: ehmicky

.gitignore

@@ -10,3 +10,4 @@ node_modules
 !.github/
 /coverage
 /build
+.netlify

CODE_OF_CONDUCT.md

@@ -58,11 +58,13 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at {{email}}. All complaints will be
-reviewed and investigated and will result in a response that is deemed necessary
-and appropriate to the circumstances. The project team is obligated to maintain
-confidentiality with regard to the reporter of an incident. Further details of
-specific enforcement policies may be posted separately.
+reported by contacting the project team at {{email}}.
+
+All complaints will be reviewed and investigated and will result in a response
+that is deemed necessary and appropriate to the circumstances. The project team
+is obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other

CONTRIBUTING.md

@@ -34,3 +34,42 @@ Make sure everything is correctly setup with:
 ```bash
 npm test
 ```
+
+# Development tasks
+
+The following development tasks are available. Please check the
+[`package.json`](/package.json) `scripts` property for more information.
+
+```bash
+npm run build
+```
+
+Runs a Netlify Build locally with the current plugin. This can be used for
+debugging and manual tests.
+
+The local Build configuration file is [`netlify.toml`](/netlify.toml) and can be
+modified.
+
+```bash
+npm run ava
+```
+
+Runs [unit tests](/test/main.js).
+
+```bash
+npm run lint
+```
+
+Lints and prettifies source files.
+
+```bash
+npm test
+```
+
+Runs both unit tests and linting.
+
+```bash
+npm run release
+```
+
+Publishes this plugin to `npm`.

LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) {{year}} {{author}}
+
+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.

LICENSE.md

@@ -1,64 +1,81 @@
-<img src="static/logo.png" width="400"/><br>
-
-<!-- START -->
+[![Netlify Status](https://api.netlify.com/api/v1/badges/79deda3b-d696-4878-b15d-d9f3a862bdfc/deploy-status)](https://app.netlify.com/sites/awesome-swanson-e132b6/deploys)
 
 Template repository to create new Netlify Build plugins.
 
-## Usage
+The main Build plugins documentation can be found
+[here](https://docs.netlify.com/configure-builds/build-plugins/).
+
+# Initialization
+
+To create a repository with a new Netlify Build plugin, click on the
+["Use this template" button](https://github.com/netlify/build-plugin-template/generate)
+on top of the page.
 
-To create a repository with a new Netlify Build plugin, click on the following
-button:
+The repository name should start with `netlify-plugin-`, for example
+`netlify-plugin-gatsby`.
 
-[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify/build-plugin-template)
+[Clone the repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
+locally.
 
-Clone the repository locally. Go to the new repository directory then run the
-following command:
+Inside the new repository directory, run the following command.
 
 ```
 npm run init
 ```
 
-After answering few questions, the Netlify Build plugin will be ready. You can
-add any logic to the main file at `src/main.js`. This file's comments will guide
-through the creation of a Build plugin.
+Some questions will be asked. Make sure the plugin's name matches the repository
+name.
 
-The following development tasks are already setup:
+Among other things, this will replace this `README.md` with the plugin's user
+documentation. Development documentation will still be available in the
+[`CONTRIBUTING.md`](/CONTRIBUTING.md#development-tasks).
 
-- `npm run ava` runs unit tests.
-- `npm run lint` lints source files.
-- `npm test` runs both unit tests and linting.
-- `npm run release` publishes this plugin to `npm`.
+Finally, create a Netlify Site with the repository. This will automatically run
+your Build plugins in Netlify Build on every `git push`, as a smoke test.
 
-## Plugin documentation
+You can also add a
+[Netlify status badge](https://docs.netlify.com/monitor-sites/status-badges/).
 
-<!-- END -->
+# Usage
 
-Netlify Build plugin - {{description}}.
+The plugin's logic should be added to [`./src/main.js`](/src/main.js). Comments
+in that file will guide you through the creation of a Build plugin.
 
-## Install
+## Development tasks
 
-```
-npm install netlify-plugin-{{name}}
+The following development tasks are available. Please check the
+[`package.json`](/package.json) `scripts` property for more information.
+
+```bash
+npm run build
 ```
 
-## Usage
+Runs a Netlify Build locally with the current plugin. This can be used for
+debugging and manual tests.
 
-Add this plugin to the `plugins` array in your
-[`netlify.yml` configuration file](https://docs.netlify.com/configure-builds/file-based-configuration):
+The local Build configuration file is [`netlify.toml`](/netlify.toml) and can be
+modified.
 
-```yml
-plugins:
-  - package: netlify-plugin-{{name}}
-    config: {}
+```bash
+npm run ava
 ```
 
-## Configuration
+Runs [unit tests](/test/main.js).
 
-The following `config` options are available:
+```bash
+npm run lint
+```
+
+Lints and prettifies source files.
 
-### foo
+```bash
+npm test
+```
 
-_Type_: `string`\
-_Default_: `bar`
+Runs both unit tests and linting.
+
+```bash
+npm run release
+```
 
-Example description of the `foo` option.
+Publishes this plugin to `npm`.

README.md

@@ -0,0 +1,4 @@
+export default {
+  timeout: '100s',
+  verbose: true,
+}

ava.config.js

@@ -0,0 +1,9 @@
+Netlify Build plugin {{name}} - {{description}}.
+
+# Install
+
+Please install this plugin from the Netlify app.
+
+# Configuration
+
+The following `inputs` options are available.

init/README.md

@@ -9,32 +9,33 @@ const { init } = require('./main.js')
 const { VARIABLES } = require('./variables/main.js')
 
 // CLI entry point of `npm run init`
-const runCli = async function() {
+const runCli = async function () {
   const flags = parseFlags()
   const flagsA = filterObj(flags, isUserFlag)
 
   try {
     await init(flagsA)
   } catch (error) {
-    console.error(error.message)
+    console.error(`${error.message}\n`)
     exit(1)
   }
 }
 
 // Parse CLI flags
-const parseFlags = function() {
-  return yargs
-    .options(FLAGS)
-    .usage(USAGE)
-    .parse()
+const parseFlags = function () {
+  return yargs.options(FLAGS).usage(USAGE).parse()
 }
 
 // Retrieve CLI flags
-const getVariablesFlags = function() {
+const getVariablesFlags = function () {
   return Object.assign(...VARIABLES.map(getVariableFlag))
 }
 
-const getVariableFlag = function({ name, description, default: defaultValue }) {
+const getVariableFlag = function ({
+  name,
+  description,
+  default: defaultValue,
+}) {
   return {
     [name]: {
       string: true,
@@ -51,7 +52,7 @@ const FLAGS = {
 const USAGE = ``
 
 // Remove `yargs`-specific options, shortcuts, dash-cased and aliases
-const isUserFlag = function(key, value) {
+const isUserFlag = function (key, value) {
   return (
     value !== undefined &&
     !INTERNAL_KEYS.includes(key) &&

scripts/init/bin.js renamed to init/bin.js

@@ -0,0 +1,61 @@
+const { readFile, writeFile } = require('fs')
+const { promisify } = require('util')
+
+const del = require('del')
+const omit = require('omit.js').default
+const filterObj = require('filter-obj')
+
+const PACKAGE_ROOT = `${__dirname}/..`
+const SCRIPTS_DIR = `${PACKAGE_ROOT}/init`
+const PACKAGE_JSON = `${PACKAGE_ROOT}/package.json`
+
+const pReadFile = promisify(readFile)
+const pWriteFile = promisify(writeFile)
+
+// Remove all files, properties and logic needed by `npm run init` once
+// `npm run init` is done.
+const cleanRepo = async function () {
+  await Promise.all([del(SCRIPTS_DIR, { force: true }), cleanPackageJson()])
+}
+
+// Remove `npm run init` in `package.json` and all `devDependencies`.
+const cleanPackageJson = async function () {
+  const content = await pReadFile(PACKAGE_JSON, 'utf8')
+  const { scripts, dependencies, devDependencies, ...packageJson } = JSON.parse(
+    content,
+  )
+
+  const scriptsA = omit(scripts, ['init'])
+  const devDependenciesA = filterObj(devDependencies, shouldKeepDevDependency)
+  const packageJsonA = {
+    ...packageJson,
+    scripts: scriptsA,
+    dependencies,
+    devDependencies: devDependenciesA,
+  }
+
+  const contentA = JSON.stringify(packageJsonA, null, 2)
+  await pWriteFile(PACKAGE_JSON, contentA)
+}
+
+// Remove devDependencies used only for initialization
+const shouldKeepDevDependency = function (key) {
+  return DEV_DEPENDENCIES.includes(key)
+}
+
+const DEV_DEPENDENCIES = [
+  '@netlify/build',
+  'ava',
+  'cross-env',
+  'eslint',
+  'eslint-config-prettier',
+  'eslint-plugin-import',
+  'eslint-plugin-node',
+  'eslint-plugin-prettier',
+  'execa',
+  'netlify-cli',
+  'prettier',
+  'release-it',
+]
+
+module.exports = { cleanRepo }

init/clean.js

@@ -0,0 +1,13 @@
+const cpy = require('cpy')
+
+const PACKAGE_ROOT = `${__dirname}/..`
+
+// Copy some files during initialization
+const copyFiles = async function () {
+  const files = FILES.map((file) => `${__dirname}/${file}`)
+  await cpy(files, PACKAGE_ROOT)
+}
+
+const FILES = ['README.md']
+
+module.exports = { copyFiles }