create-docusaurus 0.0.0-4376 → 0.0.0-4383

package/templates/facebook/node_modules/meow/readme.md

@@ -0,0 +1,352 @@
+# meow
+
+> CLI app helper
+
+![](meow.gif)
+
+## Features
+
+- Parses arguments
+- Converts flags to [camelCase](https://github.com/sindresorhus/camelcase)
+- Negates flags when using the `--no-` prefix
+- Outputs version when `--version`
+- Outputs description and supplied help text when `--help`
+- Makes unhandled rejected promises [fail hard](https://github.com/sindresorhus/hard-rejection) instead of the default silent fail
+- Sets the process title to the binary name defined in package.json
+
+## Install
+
+```
+$ npm install meow
+```
+
+## Usage
+
+```
+$ ./foo-app.js unicorns --rainbow
+```
+
+**CommonJS**
+
+```js
+#!/usr/bin/env node
+'use strict';
+const meow = require('meow');
+const foo = require('.');
+
+const cli = meow(`
+	Usage
+	  $ foo <input>
+
+	Options
+	  --rainbow, -r  Include a rainbow
+
+	Examples
+	  $ foo unicorns --rainbow
+	  🌈 unicorns 🌈
+`, {
+	flags: {
+		rainbow: {
+			type: 'boolean',
+			alias: 'r'
+		}
+	}
+});
+/*
+{
+	input: ['unicorns'],
+	flags: {rainbow: true},
+	...
+}
+*/
+
+foo(cli.input[0], cli.flags);
+```
+
+**ES Modules**
+
+```js
+#!/usr/bin/env node
+import {createRequire} from 'module';
+import foo from './lib/index.js';
+
+const meow = createRequire(import.meta.url)('meow');
+
+const cli = meow(`
+	Usage
+	  $ foo <input>
+
+	Options
+	  --rainbow, -r  Include a rainbow
+
+	Examples
+	  $ foo unicorns --rainbow
+	  🌈 unicorns 🌈
+`, {
+	flags: {
+		rainbow: {
+			type: 'boolean',
+			alias: 'r'
+		}
+	}
+});
+/*
+{
+	input: ['unicorns'],
+	flags: {rainbow: true},
+	...
+}
+*/
+
+foo(cli.input[0], cli.flags);
+```
+
+## API
+
+### meow(helpText, options?)
+### meow(options)
+
+Returns an `object` with:
+
+- `input` *(Array)* - Non-flag arguments
+- `flags` *(Object)* - Flags converted to camelCase excluding aliases
+- `unnormalizedFlags` *(Object)* - Flags converted to camelCase including aliases
+- `pkg` *(Object)* - The `package.json` object
+- `help` *(string)* - The help text used with `--help`
+- `showHelp([exitCode=2])` *(Function)* - Show the help text and exit with `exitCode`
+- `showVersion()` *(Function)* - Show the version text and exit
+
+#### helpText
+
+Type: `string`
+
+Shortcut for the `help` option.
+
+#### options
+
+Type: `object`
+
+##### flags
+
+Type: `object`
+
+Define argument flags.
+
+The key is the flag name in camel-case and the value is an object with any of:
+
+- `type`: Type of value. (Possible values: `string` `boolean` `number`)
+- `alias`: Usually used to define a short flag alias.
+- `default`: Default value when the flag is not specified.
+- `isRequired`: Determine if the flag is required. (Default: false)
+	- If it's only known at runtime whether the flag is required or not, you can pass a `Function` instead of a `boolean`, which based on the given flags and other non-flag arguments, should decide if the flag is required. Two arguments are passed to the function:
+	- The first argument is the **flags** object, which contains the flags converted to camel-case excluding aliases.
+	- The second argument is the **input** string array, which contains the non-flag arguments.
+	- The function should return a `boolean`, true if the flag is required, otherwise false.
+- `isMultiple`: Indicates a flag can be set multiple times. Values are turned into an array. (Default: false)
+	- Multiple values are provided by specifying the flag multiple times, for example, `$ foo -u rainbow -u cat`. Space- or comma-separated values are [currently *not* supported](https://github.com/sindresorhus/meow/issues/164).
+
+Note that flags are always defined using a camel-case key (`myKey`), but will match arguments in kebab-case (`--my-key`).
+
+Example:
+
+```js
+flags: {
+	unicorn: {
+		type: 'string',
+		alias: 'u',
+		default: ['rainbow', 'cat'],
+		isMultiple: true,
+		isRequired: (flags, input) => {
+			if (flags.otherFlag) {
+				return true;
+			}
+
+			return false;
+		}
+	}
+}
+```
+
+##### description
+
+Type: `string | boolean`\
+Default: The package.json `"description"` property
+
+Description to show above the help text.
+
+Set it to `false` to disable it altogether.
+
+##### help
+
+Type: `string | boolean`
+
+The help text you want shown.
+
+The input is reindented and starting/ending newlines are trimmed which means you can use a [template literal](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/template_strings) without having to care about using the correct amount of indent.
+
+The description will be shown above your help text automatically.
+
+##### version
+
+Type: `string | boolean`\
+Default: The package.json `"version"` property
+
+Set a custom version output.
+
+##### autoHelp
+
+Type: `boolean`\
+Default: `true`
+
+Automatically show the help text when the `--help` flag is present. Useful to set this value to `false` when a CLI manages child CLIs with their own help text.
+
+This option is only considered when there is only one argument in `process.argv`.
+
+##### autoVersion
+
+Type: `boolean`\
+Default: `true`
+
+Automatically show the version text when the `--version` flag is present. Useful to set this value to `false` when a CLI manages child CLIs with their own version text.
+
+ This option is only considered when there is only one argument in `process.argv`.
+
+##### pkg
+
+Type: `object`\
+Default: Closest package.json upwards
+
+package.json as an `object`.
+
+*You most likely don't need this option.*
+
+##### argv
+
+Type: `string[]`\
+Default: `process.argv.slice(2)`
+
+Custom arguments object.
+
+##### inferType
+
+Type: `boolean`\
+Default: `false`
+
+Infer the argument type.
+
+By default, the argument `5` in `$ foo 5` becomes a string. Enabling this would infer it as a number.
+
+##### booleanDefault
+
+Type: `boolean | null | undefined`\
+Default: `false`
+
+Value of `boolean` flags not defined in `argv`.
+
+If set to `undefined`, the flags not defined in `argv` will be excluded from the result.
+The `default` value set in `boolean` flags take precedence over `booleanDefault`.
+
+_Note: If used in conjunction with `isMultiple`, the default flag value is set to `[]`._
+
+__Caution: Explicitly specifying `undefined` for `booleanDefault` has different meaning from omitting key itself.__
+
+Example:
+
+```js
+const meow = require('meow');
+
+const cli = meow(`
+	Usage
+	  $ foo
+
+	Options
+	  --rainbow, -r  Include a rainbow
+	  --unicorn, -u  Include a unicorn
+	  --no-sparkles  Exclude sparkles
+
+	Examples
+	  $ foo
+	  🌈 unicorns✨🌈
+`, {
+	booleanDefault: undefined,
+	flags: {
+		rainbow: {
+			type: 'boolean',
+			default: true,
+			alias: 'r'
+		},
+		unicorn: {
+			type: 'boolean',
+			default: false,
+			alias: 'u'
+		},
+		cake: {
+			type: 'boolean',
+			alias: 'c'
+		},
+		sparkles: {
+			type: 'boolean',
+			default: true
+		}
+	}
+});
+/*
+{
+	flags: {
+		rainbow: true,
+		unicorn: false,
+		sparkles: true
+	},
+	unnormalizedFlags: {
+		rainbow: true,
+		r: true,
+		unicorn: false,
+		u: false,
+		sparkles: true
+	},
+	…
+}
+*/
+```
+
+##### hardRejection
+
+Type: `boolean`\
+Default: `true`
+
+Whether to use [`hard-rejection`](https://github.com/sindresorhus/hard-rejection) or not. Disabling this can be useful if you need to handle `process.on('unhandledRejection')` yourself.
+
+#### allowUnknownFlags
+
+Type `boolean`\
+Default: `true`
+
+Whether to allow unknown flags or not.
+
+## Promises
+
+Meow will make unhandled rejected promises [fail hard](https://github.com/sindresorhus/hard-rejection) instead of the default silent fail. Meaning you don't have to manually `.catch()` promises used in your CLI.
+
+## Tips
+
+See [`chalk`](https://github.com/chalk/chalk) if you want to colorize the terminal output.
+
+See [`get-stdin`](https://github.com/sindresorhus/get-stdin) if you want to accept input from stdin.
+
+See [`conf`](https://github.com/sindresorhus/conf) if you need to persist some data.
+
+See [`update-notifier`](https://github.com/yeoman/update-notifier) if you want update notifications.
+
+[More useful CLI utilities…](https://github.com/sindresorhus/awesome-nodejs#command-line-utilities)
+
+---
+
+<div align="center">
+	<b>
+		<a href="https://tidelift.com/subscription/pkg/npm-meow?utm_source=npm-meow&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
+	</b>
+	<br>
+	<sub>
+		Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
+	</sub>
+</div>

package/templates/facebook/node_modules/normalize-package-data/AUTHORS

@@ -0,0 +1,4 @@
+# Names sorted by how much code was originally theirs.
+Isaac Z. Schlueter <i@izs.me>
+Meryn Stol <merynstol@gmail.com>
+Robert Kowalski <rok@kowalski.gd>

package/templates/facebook/node_modules/normalize-package-data/LICENSE

@@ -0,0 +1,15 @@
+This package contains code originally written by Isaac Z. Schlueter.
+Used with permission.
+
+Copyright (c) Meryn Stol ("Author")
+All rights reserved.
+
+The BSD License
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/templates/facebook/node_modules/normalize-package-data/README.md

@@ -0,0 +1,108 @@
+# normalize-package-data
+
+[![Build Status](https://travis-ci.org/npm/normalize-package-data.svg?branch=master)](https://travis-ci.org/npm/normalize-package-data)
+
+normalize-package-data exports a function that normalizes package metadata. This data is typically found in a package.json file, but in principle could come from any source - for example the npm registry.
+
+normalize-package-data is used by [read-package-json](https://npmjs.org/package/read-package-json) to normalize the data it reads from a package.json file. In turn, read-package-json is used by [npm](https://npmjs.org/package/npm) and various npm-related tools.
+
+## Installation
+
+```
+npm install normalize-package-data
+```
+
+## Usage
+
+Basic usage is really simple. You call the function that normalize-package-data exports. Let's call it `normalizeData`.
+
+```javascript
+normalizeData = require('normalize-package-data')
+packageData = require("./package.json")
+normalizeData(packageData)
+// packageData is now normalized
+```
+
+#### Strict mode
+
+You may activate strict validation by passing true as the second argument.
+
+```javascript
+normalizeData = require('normalize-package-data')
+packageData = require("./package.json")
+normalizeData(packageData, true)
+// packageData is now normalized
+```
+
+If strict mode is activated, only Semver 2.0 version strings are accepted. Otherwise, Semver 1.0 strings are accepted as well. Packages must have a name, and the name field must not have contain leading or trailing whitespace.
+
+#### Warnings
+
+Optionally, you may pass a "warning" function. It gets called whenever the `normalizeData` function encounters something that doesn't look right. It indicates less than perfect input data.
+
+```javascript
+normalizeData = require('normalize-package-data')
+packageData = require("./package.json")
+warnFn = function(msg) { console.error(msg) }
+normalizeData(packageData, warnFn)
+// packageData is now normalized. Any number of warnings may have been logged.
+```
+
+You may combine strict validation with warnings by passing `true` as the second argument, and `warnFn` as third.
+
+When `private` field is set to `true`, warnings will be suppressed.
+
+### Potential exceptions
+
+If the supplied data has an invalid name or version vield, `normalizeData` will throw an error. Depending on where you call `normalizeData`, you may want to catch these errors so can pass them to a callback.
+
+## What normalization (currently) entails
+
+* The value of `name` field gets trimmed (unless in strict mode).
+* The value of the `version` field gets cleaned by `semver.clean`. See [documentation for the semver module](https://github.com/isaacs/node-semver).
+* If `name` and/or `version` fields are missing, they are set to empty strings.
+* If `files` field is not an array, it will be removed.
+* If `bin` field is a string, then `bin` field will become an object with `name` set to the value of the `name` field, and `bin` set to the original string value.
+* If `man` field is a string, it will become an array with the original string as its sole member.
+* If `keywords` field is string, it is considered to be a list of keywords separated by one or more white-space characters. It gets converted to an array by splitting on `\s+`.
+* All people fields (`author`, `maintainers`, `contributors`) get converted into objects with name, email and url properties.
+* If `bundledDependencies` field (a typo) exists and `bundleDependencies` field does not, `bundledDependencies` will get renamed to `bundleDependencies`.
+* If the value of any of the dependencies fields  (`dependencies`, `devDependencies`, `optionalDependencies`) is a string, it gets converted into an object with familiar `name=>value` pairs.
+* The values in `optionalDependencies` get added to `dependencies`. The `optionalDependencies` array is left untouched.
+* As of v2: Dependencies that point at known hosted git providers (currently: github, bitbucket, gitlab) will have their URLs canonicalized, but protocols will be preserved.
+* As of v2: Dependencies that use shortcuts for hosted git providers (`org/proj`, `github:org/proj`, `bitbucket:org/proj`, `gitlab:org/proj`, `gist:docid`) will have the shortcut left in place. (In the case of github, the `org/proj` form will be expanded to `github:org/proj`.) THIS MARKS A BREAKING CHANGE FROM V1, where the shorcut was previously expanded to a URL.
+* If `description` field does not exist, but `readme` field does, then (more or less) the first paragraph of text that's found in the readme is taken as value for `description`.
+* If `repository` field is a string, it will become an object with `url` set to the original string value, and `type` set to `"git"`.
+* If `repository.url` is not a valid url, but in the style of "[owner-name]/[repo-name]", `repository.url` will be set to git+https://github.com/[owner-name]/[repo-name].git
+* If `bugs` field is a string, the value of `bugs` field is changed into an object with `url` set to the original string value.
+* If `bugs` field does not exist, but `repository` field points to a repository hosted on GitHub, the value of the `bugs` field gets set to an url in the form of https://github.com/[owner-name]/[repo-name]/issues . If the repository field points to a GitHub Gist repo url, the associated http url is chosen.
+* If `bugs` field is an object, the resulting value only has email and url properties. If email and url properties are not strings, they are ignored. If no valid values for either email or url is found, bugs field will be removed.
+* If `homepage` field is not a string, it will be removed.
+* If the url in the `homepage` field does not specify a protocol, then http is assumed. For example, `myproject.org` will be changed to `http://myproject.org`.
+* If `homepage` field does not exist, but `repository` field points to a repository hosted on GitHub, the value of the `homepage` field gets set to an url in the form of https://github.com/[owner-name]/[repo-name]#readme . If the repository field points to a GitHub Gist repo url, the associated http url is chosen.
+
+### Rules for name field
+
+If `name` field is given, the value of the name field must be a string. The string may not:
+
+* start with a period.
+* contain the following characters: `/@\s+%`
+* contain any characters that would need to be encoded for use in urls.
+* resemble the word `node_modules` or `favicon.ico` (case doesn't matter).
+
+### Rules for version field
+
+If `version` field is given, the value of the version field must be a valid *semver* string, as determined by the `semver.valid` method. See [documentation for the semver module](https://github.com/isaacs/node-semver).
+
+### Rules for license field
+
+The `license`/`licence` field should be a valid *SPDX license expression* or one of the special values allowed by [validate-npm-package-license](https://npmjs.com/package/validate-npm-package-license). See [documentation for the license field in package.json](https://docs.npmjs.com/files/package.json#license).
+
+## Credits
+
+This package contains code based on read-package-json written by Isaac Z. Schlueter. Used with permisson.
+
+## License
+
+normalize-package-data is released under the [BSD 2-Clause License](https://opensource.org/licenses/BSD-2-Clause).
+Copyright (c) 2013 Meryn Stol

package/templates/facebook/node_modules/normalize-package-data/lib/extract_description.js

@@ -0,0 +1,22 @@
+module.exports = extractDescription
+
+// Extracts description from contents of a readme file in markdown format
+function extractDescription (d) {
+  if (!d) {
+    return
+  }
+  if (d === 'ERROR: No README data found!') {
+    return
+  }
+  // the first block of text before the first heading
+  // that isn't the first line heading
+  d = d.trim().split('\n')
+  for (var s = 0; d[s] && d[s].trim().match(/^(#|$)/); s++) {
+    ;
+  }
+  var l = d.length
+  for (var e = s + 1; e < l && d[e].trim(); e++) {
+    ;
+  }
+  return d.slice(s, e).join(' ').trim()
+}