update
This commit is contained in:
@@ -0,0 +1 @@
|
||||
{"version":3,"names":["_getPrototypeOf","o","exports","default","Object","setPrototypeOf","getPrototypeOf","bind","__proto__"],"sources":["../../src/helpers/getPrototypeOf.ts"],"sourcesContent":["/* @minVersion 7.0.0-beta.0 */\n\nexport default function _getPrototypeOf(o: object): any {\n // @ts-expect-error explicitly assign to function\n _getPrototypeOf = Object.setPrototypeOf\n ? // @ts-expect-error -- intentionally omitting the argument\n Object.getPrototypeOf.bind(/* undefined */)\n : function _getPrototypeOf<T extends object>(o: T) {\n return (o as any).__proto__ || Object.getPrototypeOf(o);\n };\n return _getPrototypeOf(o);\n}\n"],"mappings":";;;;;;AAEe,SAASA,eAAeA,CAACC,CAAS,EAAO;EAEtDC,OAAA,CAAAC,OAAA,GAAAH,eAAe,GAAGI,MAAM,CAACC,cAAc,GAEnCD,MAAM,CAACE,cAAc,CAACC,IAAI,CAAgB,CAAC,GAC3C,SAASP,eAAeA,CAAmBC,CAAI,EAAE;IAC/C,OAAQA,CAAC,CAASO,SAAS,IAAIJ,MAAM,CAACE,cAAc,CAACL,CAAC,CAAC;EACzD,CAAC;EACL,OAAOD,eAAe,CAACC,CAAC,CAAC;AAC3B","ignoreList":[]}
|
||||
@@ -0,0 +1,8 @@
|
||||
The MIT License (MIT)
|
||||
Copyright (c) 2015 Dmitry Ivanov
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* @author Toru Nagashima <https://github.com/mysticatea>
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const isCombiningCharacter = require("./is-combining-character");
|
||||
const isEmojiModifier = require("./is-emoji-modifier");
|
||||
const isRegionalIndicatorSymbol = require("./is-regional-indicator-symbol");
|
||||
const isSurrogatePair = require("./is-surrogate-pair");
|
||||
|
||||
module.exports = {
|
||||
isCombiningCharacter,
|
||||
isEmojiModifier,
|
||||
isRegionalIndicatorSymbol,
|
||||
isSurrogatePair,
|
||||
};
|
||||
@@ -0,0 +1 @@
|
||||
module.exports={A:{A:{"2":"K D E F A B mC"},B:{"1":"0 9 W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z AB BB CB DB EB FB GB HB IB JB KB LB MB NB OB I","2":"C L M G N O P","322":"Q H R S T","578":"U V"},C:{"1":"0 9 X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z AB BB CB DB EB FB GB HB IB JB KB LB MB NB OB I PC EC QC RC oC pC","2":"1 2 3 4 5 6 7 8 nC LC J PB K D E F A B C L M G N O P QB RB SB TB UB VB WB XB YB ZB aB bB cB dB eB fB gB hB iB jB kB lB mB nB oB pB qB rB sB tB uB vB MC wB NC xB yB zB 0B 1B 2B 3B 4B 5B 6B qC rC","194":"7B 8B 9B AC BC CC DC Q H R OC S T U V W"},D:{"1":"0 9 W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z AB BB CB DB EB FB GB HB IB JB KB LB MB NB OB I PC EC QC RC","2":"1 2 3 4 5 6 7 8 J PB K D E F A B C L M G N O P QB RB SB TB UB VB WB XB YB ZB aB bB cB dB eB fB gB hB iB jB kB lB mB nB oB pB qB rB sB tB uB vB MC wB NC xB yB zB 0B 1B 2B 3B 4B 5B 6B 7B 8B 9B AC BC CC DC","322":"Q H R S T","578":"U V"},E:{"1":"KC gC hC iC jC 3C","2":"J PB K D E F A B C L sC SC tC uC vC wC TC FC GC xC","2049":"ZC aC 1C JC bC cC dC eC fC 2C","2113":"IC WC XC YC","3140":"M G yC zC UC VC HC 0C"},F:{"1":"0 9B AC BC CC DC Q H R OC S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z","2":"1 2 3 4 5 6 7 8 F B C G N O P QB RB SB TB UB VB WB XB YB ZB aB bB cB dB eB fB gB hB iB jB kB lB mB nB oB pB qB rB sB tB uB vB wB xB yB zB 0B 1B 2B 3B 4B 5B 6B 7B 4C 5C 6C 7C FC kC 8C GC","578":"8B"},G:{"1":"KC gC hC iC jC","2":"E SC 9C lC AD BD CD DD ED FD GD HD ID JD KD LD MD ND OD PD","2049":"ZC aC UD JC bC cC dC eC fC VD","2113":"IC WC XC YC","2116":"QD RD SD UC VC HC TD"},H:{"2":"WD"},I:{"1":"I","2":"LC J XD YD ZD aD lC bD cD"},J:{"2":"D A"},K:{"1":"H","2":"A B C FC kC GC"},L:{"1":"I"},M:{"1":"EC"},N:{"2":"A B"},O:{"1":"HC"},P:{"1":"1 2 3 4 5 6 7 8 lD mD IC JC KC nD","2":"J dD eD fD gD hD TC iD jD kD"},Q:{"2":"oD"},R:{"1":"pD"},S:{"2":"qD rD"}},B:6,C:"HTTP/3 protocol",D:true};
|
||||
@@ -0,0 +1,24 @@
|
||||
/**
|
||||
* @license React
|
||||
* react-compiler-runtime.development.js
|
||||
*
|
||||
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
"use strict";
|
||||
"production" !== process.env.NODE_ENV &&
|
||||
(function () {
|
||||
var ReactSharedInternals =
|
||||
require("react").__CLIENT_INTERNALS_DO_NOT_USE_OR_WARN_USERS_THEY_CANNOT_UPGRADE;
|
||||
exports.c = function (size) {
|
||||
var dispatcher = ReactSharedInternals.H;
|
||||
null === dispatcher &&
|
||||
console.error(
|
||||
"Invalid hook call. Hooks can only be called inside of the body of a function component. This could happen for one of the following reasons:\n1. You might have mismatching versions of React and the renderer (such as React DOM)\n2. You might be breaking the Rules of Hooks\n3. You might have more than one copy of React in the same app\nSee https://react.dev/link/invalid-hook-call for tips about how to debug and fix this problem."
|
||||
);
|
||||
return dispatcher.useMemoCache(size);
|
||||
};
|
||||
})();
|
||||
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"searchParams.js","sources":["../../src/searchParams.ts"],"sourcesContent":["import { decode, encode } from './qss'\nimport type { AnySchema } from './validators'\n\nexport const defaultParseSearch = parseSearchWith(JSON.parse)\nexport const defaultStringifySearch = stringifySearchWith(\n JSON.stringify,\n JSON.parse,\n)\n\nexport function parseSearchWith(parser: (str: string) => any) {\n return (searchStr: string): AnySchema => {\n if (searchStr.substring(0, 1) === '?') {\n searchStr = searchStr.substring(1)\n }\n\n const query: Record<string, unknown> = decode(searchStr)\n\n // Try to parse any query params that might be json\n for (const key in query) {\n const value = query[key]\n if (typeof value === 'string') {\n try {\n query[key] = parser(value)\n } catch (err) {\n //\n }\n }\n }\n\n return query\n }\n}\n\nexport function stringifySearchWith(\n stringify: (search: any) => string,\n parser?: (str: string) => any,\n) {\n function stringifyValue(val: any) {\n if (typeof val === 'object' && val !== null) {\n try {\n return stringify(val)\n } catch (err) {\n // silent\n }\n } else if (typeof val === 'string' && typeof parser === 'function') {\n try {\n // Check if it's a valid parseable string.\n // If it is, then stringify it again.\n parser(val)\n return stringify(val)\n } catch (err) {\n // silent\n }\n }\n return val\n }\n\n return (search: Record<string, any>) => {\n search = { ...search }\n\n Object.keys(search).forEach((key) => {\n const val = search[key]\n if (typeof val === 'undefined' || val === undefined) {\n delete search[key]\n } else {\n search[key] = stringifyValue(val)\n }\n })\n\n const searchStr = encode(search as Record<string, string>).toString()\n\n return searchStr ? `?${searchStr}` : ''\n }\n}\n\nexport type SearchSerializer = (searchObj: Record<string, any>) => string\nexport type SearchParser = (searchStr: string) => Record<string, any>\n"],"names":[],"mappings":";AAGa,MAAA,qBAAqB,gBAAgB,KAAK,KAAK;AACrD,MAAM,yBAAyB;AAAA,EACpC,KAAK;AAAA,EACL,KAAK;AACP;AAEO,SAAS,gBAAgB,QAA8B;AAC5D,SAAO,CAAC,cAAiC;AACvC,QAAI,UAAU,UAAU,GAAG,CAAC,MAAM,KAAK;AACzB,kBAAA,UAAU,UAAU,CAAC;AAAA,IAAA;AAG7B,UAAA,QAAiC,OAAO,SAAS;AAGvD,eAAW,OAAO,OAAO;AACjB,YAAA,QAAQ,MAAM,GAAG;AACnB,UAAA,OAAO,UAAU,UAAU;AACzB,YAAA;AACI,gBAAA,GAAG,IAAI,OAAO,KAAK;AAAA,iBAClB,KAAK;AAAA,QAAA;AAAA,MAEd;AAAA,IACF;AAGK,WAAA;AAAA,EACT;AACF;AAEgB,SAAA,oBACd,WACA,QACA;AACA,WAAS,eAAe,KAAU;AAChC,QAAI,OAAO,QAAQ,YAAY,QAAQ,MAAM;AACvC,UAAA;AACF,eAAO,UAAU,GAAG;AAAA,eACb,KAAK;AAAA,MAAA;AAAA,eAGL,OAAO,QAAQ,YAAY,OAAO,WAAW,YAAY;AAC9D,UAAA;AAGF,eAAO,GAAG;AACV,eAAO,UAAU,GAAG;AAAA,eACb,KAAK;AAAA,MAAA;AAAA,IAEd;AAEK,WAAA;AAAA,EAAA;AAGT,SAAO,CAAC,WAAgC;AAC7B,aAAA,EAAE,GAAG,OAAO;AAErB,WAAO,KAAK,MAAM,EAAE,QAAQ,CAAC,QAAQ;AAC7B,YAAA,MAAM,OAAO,GAAG;AACtB,UAAI,OAAO,QAAQ,eAAe,QAAQ,QAAW;AACnD,eAAO,OAAO,GAAG;AAAA,MAAA,OACZ;AACE,eAAA,GAAG,IAAI,eAAe,GAAG;AAAA,MAAA;AAAA,IAClC,CACD;AAED,UAAM,YAAY,OAAO,MAAgC,EAAE,SAAS;AAE7D,WAAA,YAAY,IAAI,SAAS,KAAK;AAAA,EACvC;AACF;"}
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1 @@
|
||||
module.exports={A:{A:{"1":"A B","2":"K D E F mC"},B:{"1":"C L M G N O P","516":"0 9 Q H R S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z AB BB CB DB EB FB GB HB IB JB KB LB MB NB OB I"},C:{"132":"pB qB rB sB tB uB vB MC wB NC xB yB zB","164":"1 2 3 4 5 6 7 8 nC LC J PB K D E F A B C L M G N O P QB RB SB TB UB VB WB XB YB ZB aB bB cB dB eB fB gB hB iB jB kB lB mB nB oB qC rC","516":"0B 1B 2B 3B 4B 5B 6B 7B 8B 9B AC BC CC DC Q H R OC S T U V W X Y Z a","1028":"0 9 b c d e f g h i j k l m n o p q r s t u v w x y z AB BB CB DB EB FB GB HB IB JB KB LB MB NB OB I PC EC QC RC oC pC"},D:{"420":"1 2 3 4 5 6 7 8 J PB K D E F A B C L M G N O P QB RB SB TB UB VB WB XB YB ZB aB bB cB dB eB fB gB hB iB jB kB lB mB","516":"0 9 nB oB pB qB rB sB tB uB vB MC wB NC xB yB zB 0B 1B 2B 3B 4B 5B 6B 7B 8B 9B AC BC CC DC Q H R S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z AB BB CB DB EB FB GB HB IB JB KB LB MB NB OB I PC EC QC RC"},E:{"1":"A B C L M G TC FC GC xC yC zC UC VC HC 0C IC WC XC YC ZC aC 1C JC bC cC dC eC fC 2C KC gC hC iC jC 3C","132":"F wC","164":"D E vC","420":"J PB K sC SC tC uC"},F:{"1":"C FC kC 8C GC","2":"F B 4C 5C 6C 7C","420":"1 2 3 4 5 6 7 8 G N O P QB RB SB TB UB VB WB XB YB ZB","516":"0 aB bB cB dB eB fB gB hB iB jB kB lB mB nB oB pB qB rB sB tB uB vB wB xB yB zB 0B 1B 2B 3B 4B 5B 6B 7B 8B 9B AC BC CC DC Q H R OC S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z"},G:{"1":"GD HD ID JD KD LD MD ND OD PD QD RD SD UC VC HC TD IC WC XC YC ZC aC UD JC bC cC dC eC fC VD KC gC hC iC jC","132":"ED FD","164":"E CD DD","420":"SC 9C lC AD BD"},H:{"1":"WD"},I:{"420":"LC J XD YD ZD aD lC bD cD","516":"I"},J:{"420":"D A"},K:{"1":"C FC kC GC","2":"A B","516":"H"},L:{"516":"I"},M:{"1028":"EC"},N:{"1":"A B"},O:{"516":"HC"},P:{"420":"J","516":"1 2 3 4 5 6 7 8 dD eD fD gD hD TC iD jD kD lD mD IC JC KC nD"},Q:{"516":"oD"},R:{"516":"pD"},S:{"164":"qD rD"}},B:4,C:"CSS3 Multiple column layout",D:true};
|
||||
@@ -0,0 +1 @@
|
||||
module.exports={A:{A:{"2":"K D E F A B mC"},B:{"1":"0 9 Q H R S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z AB BB CB DB EB FB GB HB IB JB KB LB MB NB OB I","2":"C L M G N O P"},C:{"2":"0 1 2 3 4 5 6 7 8 9 nC LC J PB K D E F A B C L M G N O P QB RB SB TB UB VB WB XB YB ZB aB bB cB dB eB fB gB hB iB jB kB lB mB nB oB pB qB rB sB tB uB vB MC wB NC xB yB zB 0B 1B 2B 3B 4B 5B 6B 7B 8B 9B AC BC CC DC Q H R OC S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z AB BB CB DB EB FB GB HB IB JB KB LB MB NB OB I PC EC QC RC oC pC qC rC"},D:{"1":"0 9 NC xB yB zB 0B 1B 2B 3B 4B 5B 6B 7B 8B 9B AC BC CC DC Q H R S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z AB BB CB DB EB FB GB HB IB JB KB LB MB NB OB I PC EC QC RC","2":"1 2 3 4 5 6 7 8 J PB K D E F A B C L M G N O P QB RB SB TB UB VB WB XB YB ZB aB bB cB dB eB fB gB hB iB jB kB lB mB nB oB pB qB","66":"rB sB tB uB vB MC wB"},E:{"2":"J PB K D E F A B C L M G sC SC tC uC vC wC TC FC GC xC yC zC UC VC HC 0C IC WC XC YC ZC aC 1C JC bC cC dC eC fC 2C KC gC hC iC jC 3C"},F:{"1":"0 lB mB nB oB pB qB rB sB tB uB vB wB xB yB zB 0B 1B 2B 3B 4B 5B 6B 7B 8B 9B AC BC CC DC Q H R OC S T U V W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z","2":"1 2 3 4 5 6 7 8 F B C G N O P QB RB SB TB UB VB WB XB YB ZB aB bB cB dB 4C 5C 6C 7C FC kC 8C GC","66":"eB fB gB hB iB jB kB"},G:{"2":"E SC 9C lC AD BD CD DD ED FD GD HD ID JD KD LD MD ND OD PD QD RD SD UC VC HC TD IC WC XC YC ZC aC UD JC bC cC dC eC fC VD KC gC hC iC jC"},H:{"2":"WD"},I:{"2":"LC J I XD YD ZD aD lC bD cD"},J:{"2":"D A"},K:{"1":"H","2":"A B C FC kC GC"},L:{"1":"I"},M:{"2":"EC"},N:{"2":"A B"},O:{"1":"HC"},P:{"1":"1 2 3 4 5 6 7 8 gD hD TC iD jD kD lD mD IC JC KC nD","2":"J dD eD fD"},Q:{"2":"oD"},R:{"1":"pD"},S:{"2":"qD rD"}},B:7,C:"WebUSB",D:true};
|
||||
@@ -0,0 +1,238 @@
|
||||
# Optionator
|
||||
<a name="optionator" />
|
||||
|
||||
Optionator is a JavaScript/Node.js option parsing and help generation library used by [eslint](http://eslint.org), [Grasp](http://graspjs.com), [LiveScript](http://livescript.net), [esmangle](https://github.com/estools/esmangle), [escodegen](https://github.com/estools/escodegen), and [many more](https://www.npmjs.com/browse/depended/optionator).
|
||||
|
||||
For an online demo, check out the [Grasp online demo](http://www.graspjs.com/#demo).
|
||||
|
||||
[About](#about) · [Usage](#usage) · [Settings Format](#settings-format) · [Argument Format](#argument-format)
|
||||
|
||||
## Why?
|
||||
The problem with other option parsers, such as `yargs` or `minimist`, is they just accept all input, valid or not.
|
||||
With Optionator, if you mistype an option, it will give you an error (with a suggestion for what you meant).
|
||||
If you give the wrong type of argument for an option, it will give you an error rather than supplying the wrong input to your application.
|
||||
|
||||
$ cmd --halp
|
||||
Invalid option '--halp' - perhaps you meant '--help'?
|
||||
|
||||
$ cmd --count str
|
||||
Invalid value for option 'count' - expected type Int, received value: str.
|
||||
|
||||
Other helpful features include reformatting the help text based on the size of the console, so that it fits even if the console is narrow, and accepting not just an array (eg. process.argv), but a string or object as well, making things like testing much easier.
|
||||
|
||||
## About
|
||||
Optionator uses [type-check](https://github.com/gkz/type-check) and [levn](https://github.com/gkz/levn) behind the scenes to cast and verify input according the specified types.
|
||||
|
||||
MIT license. Version 0.9.4
|
||||
|
||||
npm install optionator
|
||||
|
||||
For updates on Optionator, [follow me on twitter](https://twitter.com/gkzahariev).
|
||||
|
||||
Optionator is a Node.js module, but can be used in the browser as well if packed with webpack/browserify.
|
||||
|
||||
## Usage
|
||||
`require('optionator');` returns a function. It has one property, `VERSION`, the current version of the library as a string. This function is called with an object specifying your options and other information, see the [settings format section](#settings-format). This in turn returns an object with three properties, `parse`, `parseArgv`, `generateHelp`, and `generateHelpForOption`, which are all functions.
|
||||
|
||||
```js
|
||||
var optionator = require('optionator')({
|
||||
prepend: 'Usage: cmd [options]',
|
||||
append: 'Version 1.0.0',
|
||||
options: [{
|
||||
option: 'help',
|
||||
alias: 'h',
|
||||
type: 'Boolean',
|
||||
description: 'displays help'
|
||||
}, {
|
||||
option: 'count',
|
||||
alias: 'c',
|
||||
type: 'Int',
|
||||
description: 'number of things',
|
||||
example: 'cmd --count 2'
|
||||
}]
|
||||
});
|
||||
|
||||
var options = optionator.parseArgv(process.argv);
|
||||
if (options.help) {
|
||||
console.log(optionator.generateHelp());
|
||||
}
|
||||
...
|
||||
```
|
||||
|
||||
### parse(input, parseOptions)
|
||||
`parse` processes the `input` according to your settings, and returns an object with the results.
|
||||
|
||||
##### arguments
|
||||
* input - `[String] | Object | String` - the input you wish to parse
|
||||
* parseOptions - `{slice: Int}` - all options optional
|
||||
- `slice` specifies how much to slice away from the beginning if the input is an array or string - by default `0` for string, `2` for array (works with `process.argv`)
|
||||
|
||||
##### returns
|
||||
`Object` - the parsed options, each key is a camelCase version of the option name (specified in dash-case), and each value is the processed value for that option. Positional values are in an array under the `_` key.
|
||||
|
||||
##### example
|
||||
```js
|
||||
parse(['node', 't.js', '--count', '2', 'positional']); // {count: 2, _: ['positional']}
|
||||
parse('--count 2 positional'); // {count: 2, _: ['positional']}
|
||||
parse({count: 2, _:['positional']}); // {count: 2, _: ['positional']}
|
||||
```
|
||||
|
||||
### parseArgv(input)
|
||||
`parseArgv` works exactly like `parse`, but only for array input and it slices off the first two elements.
|
||||
|
||||
##### arguments
|
||||
* input - `[String]` - the input you wish to parse
|
||||
|
||||
##### returns
|
||||
See "returns" section in "parse"
|
||||
|
||||
##### example
|
||||
```js
|
||||
parseArgv(process.argv);
|
||||
```
|
||||
|
||||
### generateHelp(helpOptions)
|
||||
`generateHelp` produces help text based on your settings.
|
||||
|
||||
##### arguments
|
||||
* helpOptions - `{showHidden: Boolean, interpolate: Object}` - all options optional
|
||||
- `showHidden` specifies whether to show options with `hidden: true` specified, by default it is `false`
|
||||
- `interpolate` specify data to be interpolated in `prepend` and `append` text, `{{key}}` is the format - eg. `generateHelp({interpolate:{version: '0.4.2'}})`, will change this `append` text: `Version {{version}}` to `Version 0.4.2`
|
||||
|
||||
##### returns
|
||||
`String` - the generated help text
|
||||
|
||||
##### example
|
||||
```js
|
||||
generateHelp(); /*
|
||||
"Usage: cmd [options] positional
|
||||
|
||||
-h, --help displays help
|
||||
-c, --count Int number of things
|
||||
|
||||
Version 1.0.0
|
||||
"*/
|
||||
```
|
||||
|
||||
### generateHelpForOption(optionName)
|
||||
`generateHelpForOption` produces expanded help text for the specified with `optionName` option. If an `example` was specified for the option, it will be displayed, and if a `longDescription` was specified, it will display that instead of the `description`.
|
||||
|
||||
##### arguments
|
||||
* optionName - `String` - the name of the option to display
|
||||
|
||||
##### returns
|
||||
`String` - the generated help text for the option
|
||||
|
||||
##### example
|
||||
```js
|
||||
generateHelpForOption('count'); /*
|
||||
"-c, --count Int
|
||||
description: number of things
|
||||
example: cmd --count 2
|
||||
"*/
|
||||
```
|
||||
|
||||
## Settings Format
|
||||
When your `require('optionator')`, you get a function that takes in a settings object. This object has the type:
|
||||
|
||||
{
|
||||
prepend: String,
|
||||
append: String,
|
||||
options: [{heading: String} | {
|
||||
option: String,
|
||||
alias: [String] | String,
|
||||
type: String,
|
||||
enum: [String],
|
||||
default: String,
|
||||
restPositional: Boolean,
|
||||
required: Boolean,
|
||||
overrideRequired: Boolean,
|
||||
dependsOn: [String] | String,
|
||||
concatRepeatedArrays: Boolean | (Boolean, Object),
|
||||
mergeRepeatedObjects: Boolean,
|
||||
description: String,
|
||||
longDescription: String,
|
||||
example: [String] | String
|
||||
}],
|
||||
helpStyle: {
|
||||
aliasSeparator: String,
|
||||
typeSeparator: String,
|
||||
descriptionSeparator: String,
|
||||
initialIndent: Int,
|
||||
secondaryIndent: Int,
|
||||
maxPadFactor: Number
|
||||
},
|
||||
mutuallyExclusive: [[String | [String]]],
|
||||
concatRepeatedArrays: Boolean | (Boolean, Object), // deprecated, set in defaults object
|
||||
mergeRepeatedObjects: Boolean, // deprecated, set in defaults object
|
||||
positionalAnywhere: Boolean,
|
||||
typeAliases: Object,
|
||||
defaults: Object
|
||||
}
|
||||
|
||||
All of the properties are optional (the `Maybe` has been excluded for brevities sake), except for having either `heading: String` or `option: String` in each object in the `options` array.
|
||||
|
||||
### Top Level Properties
|
||||
* `prepend` is an optional string to be placed before the options in the help text
|
||||
* `append` is an optional string to be placed after the options in the help text
|
||||
* `options` is a required array specifying your options and headings, the options and headings will be displayed in the order specified
|
||||
* `helpStyle` is an optional object which enables you to change the default appearance of some aspects of the help text
|
||||
* `mutuallyExclusive` is an optional array of arrays of either strings or arrays of strings. The top level array is a list of rules, each rule is a list of elements - each element can be either a string (the name of an option), or a list of strings (a group of option names) - there will be an error if more than one element is present
|
||||
* `concatRepeatedArrays` see description under the "Option Properties" heading - use at the top level is deprecated, if you want to set this for all options, use the `defaults` property
|
||||
* `mergeRepeatedObjects` see description under the "Option Properties" heading - use at the top level is deprecated, if you want to set this for all options, use the `defaults` property
|
||||
* `positionalAnywhere` is an optional boolean (defaults to `true`) - when `true` it allows positional arguments anywhere, when `false`, all arguments after the first positional one are taken to be positional as well, even if they look like a flag. For example, with `positionalAnywhere: false`, the arguments `--flag --boom 12 --crack` would have two positional arguments: `12` and `--crack`
|
||||
* `typeAliases` is an optional object, it allows you to set aliases for types, eg. `{Path: 'String'}` would allow you to use the type `Path` as an alias for the type `String`
|
||||
* `defaults` is an optional object following the option properties format, which specifies default values for all options. A default will be overridden if manually set. For example, you can do `default: { type: "String" }` to set the default type of all options to `String`, and then override that default in an individual option by setting the `type` property
|
||||
|
||||
#### Heading Properties
|
||||
* `heading` a required string, the name of the heading
|
||||
|
||||
#### Option Properties
|
||||
* `option` the required name of the option - use dash-case, without the leading dashes
|
||||
* `alias` is an optional string or array of strings which specify any aliases for the option
|
||||
* `type` is a required string in the [type check](https://github.com/gkz/type-check) [format](https://github.com/gkz/type-check#type-format), this will be used to cast the inputted value and validate it
|
||||
* `enum` is an optional array of strings, each string will be parsed by [levn](https://github.com/gkz/levn) - the argument value must be one of the resulting values - each potential value must validate against the specified `type`
|
||||
* `default` is a optional string, which will be parsed by [levn](https://github.com/gkz/levn) and used as the default value if none is set - the value must validate against the specified `type`
|
||||
* `restPositional` is an optional boolean - if set to `true`, everything after the option will be taken to be a positional argument, even if it looks like a named argument
|
||||
* `required` is an optional boolean - if set to `true`, the option parsing will fail if the option is not defined
|
||||
* `overrideRequired` is a optional boolean - if set to `true` and the option is used, and there is another option which is required but not set, it will override the need for the required option and there will be no error - this is useful if you have required options and want to use `--help` or `--version` flags
|
||||
* `concatRepeatedArrays` is an optional boolean or tuple with boolean and options object (defaults to `false`) - when set to `true` and an option contains an array value and is repeated, the subsequent values for the flag will be appended rather than overwriting the original value - eg. option `g` of type `[String]`: `-g a -g b -g c,d` will result in `['a','b','c','d']`
|
||||
|
||||
You can supply an options object by giving the following value: `[true, options]`. The one currently supported option is `oneValuePerFlag`, this only allows one array value per flag. This is useful if your potential values contain a comma.
|
||||
* `mergeRepeatedObjects` is an optional boolean (defaults to `false`) - when set to `true` and an option contains an object value and is repeated, the subsequent values for the flag will be merged rather than overwriting the original value - eg. option `g` of type `Object`: `-g a:1 -g b:2 -g c:3,d:4` will result in `{a: 1, b: 2, c: 3, d: 4}`
|
||||
* `dependsOn` is an optional string or array of strings - if simply a string (the name of another option), it will make sure that that other option is set, if an array of strings, depending on whether `'and'` or `'or'` is first, it will either check whether all (`['and', 'option-a', 'option-b']`), or at least one (`['or', 'option-a', 'option-b']`) other options are set
|
||||
* `description` is an optional string, which will be displayed next to the option in the help text
|
||||
* `longDescription` is an optional string, it will be displayed instead of the `description` when `generateHelpForOption` is used
|
||||
* `example` is an optional string or array of strings with example(s) for the option - these will be displayed when `generateHelpForOption` is used
|
||||
|
||||
#### Help Style Properties
|
||||
* `aliasSeparator` is an optional string, separates multiple names from each other - default: ' ,'
|
||||
* `typeSeparator` is an optional string, separates the type from the names - default: ' '
|
||||
* `descriptionSeparator` is an optional string , separates the description from the padded name and type - default: ' '
|
||||
* `initialIndent` is an optional int - the amount of indent for options - default: 2
|
||||
* `secondaryIndent` is an optional int - the amount of indent if wrapped fully (in addition to the initial indent) - default: 4
|
||||
* `maxPadFactor` is an optional number - affects the default level of padding for the names/type, it is multiplied by the average of the length of the names/type - default: 1.5
|
||||
|
||||
## Argument Format
|
||||
At the highest level there are two types of arguments: named, and positional.
|
||||
|
||||
Name arguments of any length are prefixed with `--` (eg. `--go`), and those of one character may be prefixed with either `--` or `-` (eg. `-g`).
|
||||
|
||||
There are two types of named arguments: boolean flags (eg. `--problemo`, `-p`) which take no value and result in a `true` if they are present, the falsey `undefined` if they are not present, or `false` if present and explicitly prefixed with `no` (eg. `--no-problemo`). Named arguments with values (eg. `--tseries 800`, `-t 800`) are the other type. If the option has a type `Boolean` it will automatically be made into a boolean flag. Any other type results in a named argument that takes a value.
|
||||
|
||||
For more information about how to properly set types to get the value you want, take a look at the [type check](https://github.com/gkz/type-check) and [levn](https://github.com/gkz/levn) pages.
|
||||
|
||||
You can group single character arguments that use a single `-`, however all except the last must be boolean flags (which take no value). The last may be a boolean flag, or an argument which takes a value - eg. `-ba 2` is equivalent to `-b -a 2`.
|
||||
|
||||
Positional arguments are all those values which do not fall under the above - they can be anywhere, not just at the end. For example, in `cmd -b one -a 2 two` where `b` is a boolean flag, and `a` has the type `Number`, there are two positional arguments, `one` and `two`.
|
||||
|
||||
Everything after an `--` is positional, even if it looks like a named argument.
|
||||
|
||||
You may optionally use `=` to separate option names from values, for example: `--count=2`.
|
||||
|
||||
If you specify the option `NUM`, then any argument using a single `-` followed by a number will be valid and will set the value of `NUM`. Eg. `-2` will be parsed into `NUM: 2`.
|
||||
|
||||
If duplicate named arguments are present, the last one will be taken.
|
||||
|
||||
## Technical About
|
||||
`optionator` is written in [LiveScript](http://livescript.net/) - a language that compiles to JavaScript. It uses [levn](https://github.com/gkz/levn) to cast arguments to their specified type, and uses [type-check](https://github.com/gkz/type-check) to validate values. It also uses the [prelude.ls](http://preludels.com/) library.
|
||||
Binary file not shown.
File diff suppressed because one or more lines are too long
@@ -0,0 +1 @@
|
||||
{"version":3,"names":["DEPRECATED_ALIASES","exports","ModuleDeclaration"],"sources":["../../src/definitions/deprecated-aliases.ts"],"sourcesContent":["export const DEPRECATED_ALIASES = {\n ModuleDeclaration: \"ImportOrExportDeclaration\",\n};\n"],"mappings":";;;;;;AAAO,MAAMA,kBAAkB,GAAAC,OAAA,CAAAD,kBAAA,GAAG;EAChCE,iBAAiB,EAAE;AACrB,CAAC","ignoreList":[]}
|
||||
@@ -0,0 +1,121 @@
|
||||
/* -*- Mode: js; js-indent-level: 2; -*- */
|
||||
/*
|
||||
* Copyright 2011 Mozilla Foundation and contributors
|
||||
* Licensed under the New BSD license. See LICENSE or:
|
||||
* http://opensource.org/licenses/BSD-3-Clause
|
||||
*/
|
||||
|
||||
var util = require('./util');
|
||||
var has = Object.prototype.hasOwnProperty;
|
||||
var hasNativeMap = typeof Map !== "undefined";
|
||||
|
||||
/**
|
||||
* A data structure which is a combination of an array and a set. Adding a new
|
||||
* member is O(1), testing for membership is O(1), and finding the index of an
|
||||
* element is O(1). Removing elements from the set is not supported. Only
|
||||
* strings are supported for membership.
|
||||
*/
|
||||
function ArraySet() {
|
||||
this._array = [];
|
||||
this._set = hasNativeMap ? new Map() : Object.create(null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Static method for creating ArraySet instances from an existing array.
|
||||
*/
|
||||
ArraySet.fromArray = function ArraySet_fromArray(aArray, aAllowDuplicates) {
|
||||
var set = new ArraySet();
|
||||
for (var i = 0, len = aArray.length; i < len; i++) {
|
||||
set.add(aArray[i], aAllowDuplicates);
|
||||
}
|
||||
return set;
|
||||
};
|
||||
|
||||
/**
|
||||
* Return how many unique items are in this ArraySet. If duplicates have been
|
||||
* added, than those do not count towards the size.
|
||||
*
|
||||
* @returns Number
|
||||
*/
|
||||
ArraySet.prototype.size = function ArraySet_size() {
|
||||
return hasNativeMap ? this._set.size : Object.getOwnPropertyNames(this._set).length;
|
||||
};
|
||||
|
||||
/**
|
||||
* Add the given string to this set.
|
||||
*
|
||||
* @param String aStr
|
||||
*/
|
||||
ArraySet.prototype.add = function ArraySet_add(aStr, aAllowDuplicates) {
|
||||
var sStr = hasNativeMap ? aStr : util.toSetString(aStr);
|
||||
var isDuplicate = hasNativeMap ? this.has(aStr) : has.call(this._set, sStr);
|
||||
var idx = this._array.length;
|
||||
if (!isDuplicate || aAllowDuplicates) {
|
||||
this._array.push(aStr);
|
||||
}
|
||||
if (!isDuplicate) {
|
||||
if (hasNativeMap) {
|
||||
this._set.set(aStr, idx);
|
||||
} else {
|
||||
this._set[sStr] = idx;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Is the given string a member of this set?
|
||||
*
|
||||
* @param String aStr
|
||||
*/
|
||||
ArraySet.prototype.has = function ArraySet_has(aStr) {
|
||||
if (hasNativeMap) {
|
||||
return this._set.has(aStr);
|
||||
} else {
|
||||
var sStr = util.toSetString(aStr);
|
||||
return has.call(this._set, sStr);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* What is the index of the given string in the array?
|
||||
*
|
||||
* @param String aStr
|
||||
*/
|
||||
ArraySet.prototype.indexOf = function ArraySet_indexOf(aStr) {
|
||||
if (hasNativeMap) {
|
||||
var idx = this._set.get(aStr);
|
||||
if (idx >= 0) {
|
||||
return idx;
|
||||
}
|
||||
} else {
|
||||
var sStr = util.toSetString(aStr);
|
||||
if (has.call(this._set, sStr)) {
|
||||
return this._set[sStr];
|
||||
}
|
||||
}
|
||||
|
||||
throw new Error('"' + aStr + '" is not in the set.');
|
||||
};
|
||||
|
||||
/**
|
||||
* What is the element at the given index?
|
||||
*
|
||||
* @param Number aIdx
|
||||
*/
|
||||
ArraySet.prototype.at = function ArraySet_at(aIdx) {
|
||||
if (aIdx >= 0 && aIdx < this._array.length) {
|
||||
return this._array[aIdx];
|
||||
}
|
||||
throw new Error('No element indexed by ' + aIdx);
|
||||
};
|
||||
|
||||
/**
|
||||
* Returns the array representation of this set (which has the proper indices
|
||||
* indicated by indexOf). Note that this is a copy of the internal array used
|
||||
* for storing the members so that no one can mess with internal state.
|
||||
*/
|
||||
ArraySet.prototype.toArray = function ArraySet_toArray() {
|
||||
return this._array.slice();
|
||||
};
|
||||
|
||||
exports.ArraySet = ArraySet;
|
||||
@@ -0,0 +1 @@
|
||||
module.exports={C:{"5":0.36946,"88":0.00255,"89":0.01019,"102":0.0051,"107":0.0051,"115":0.03567,"117":0.00764,"127":0.00255,"128":0.0051,"134":0.0051,"135":0.07644,"136":0.2599,_:"2 3 4 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 90 91 92 93 94 95 96 97 98 99 100 101 103 104 105 106 108 109 110 111 112 113 114 116 118 119 120 121 122 123 124 125 126 129 130 131 132 133 137 138 139 140 3.5 3.6"},D:{"39":0.00255,"40":0.00255,"41":0.00255,"42":0.00255,"43":0.00255,"45":0.00255,"48":0.00255,"49":0.0051,"50":0.00255,"52":0.00255,"53":0.00255,"55":0.00255,"56":0.01019,"58":0.08663,"60":0.00255,"68":0.00255,"69":0.00255,"72":0.0051,"75":0.00255,"79":0.03312,"80":0.00255,"83":0.00764,"84":0.0051,"87":0.01529,"88":0.00255,"91":0.0051,"93":0.0051,"94":0.0051,"98":0.00255,"99":0.00255,"100":0.00255,"101":0.00255,"102":0.01019,"103":0.12485,"104":0.02038,"105":0.00255,"106":0.01274,"107":0.01529,"108":0.04332,"109":0.34143,"110":0.0051,"111":0.02038,"112":0.00255,"113":0.00255,"114":0.03822,"115":0.00764,"116":0.03822,"117":0.01019,"118":0.0051,"119":0.01019,"120":0.01019,"121":0.01019,"122":0.05096,"123":0.01274,"124":0.02548,"125":0.04332,"126":0.04586,"127":0.03058,"128":0.06115,"129":0.04586,"130":0.15798,"131":0.24461,"132":0.27773,"133":4.82336,"134":9.17025,"135":0.01274,_:"4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 44 46 47 51 54 57 59 61 62 63 64 65 66 67 70 71 73 74 76 77 78 81 85 86 89 90 92 95 96 97 136 137 138"},F:{"46":0.01274,"87":0.03058,"88":0.02038,"93":0.00255,"95":0.0051,"114":0.01274,"116":0.21403,"117":0.61662,_:"9 11 12 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 47 48 49 50 51 52 53 54 55 56 57 58 60 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 89 90 91 92 94 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 115 9.5-9.6 10.0-10.1 10.5 10.6 11.1 11.5 11.6 12.1"},B:{"13":0.00764,"18":0.00255,"92":0.0051,"100":0.00255,"108":0.00255,"109":0.03058,"111":0.0051,"112":0.00255,"114":0.00255,"116":0.00255,"121":0.00255,"122":0.00255,"124":0.00255,"125":0.01019,"126":0.00255,"127":0.00255,"129":0.00255,"130":0.01019,"131":0.0688,"132":0.04586,"133":0.82555,"134":1.93138,_:"12 14 15 16 17 79 80 81 83 84 85 86 87 88 89 90 91 93 94 95 96 97 98 99 101 102 103 104 105 106 107 110 113 115 117 118 119 120 123 128"},E:{"14":0.00255,"15":0.0051,_:"0 4 5 6 7 8 9 10 11 12 13 3.1 3.2 6.1 7.1 9.1 10.1 11.1 12.1","5.1":0.00255,"13.1":0.05351,"14.1":0.02038,"15.1":0.00255,"15.2-15.3":0.00255,"15.4":0.00255,"15.5":0.01019,"15.6":0.07134,"16.0":0.01019,"16.1":0.01529,"16.2":0.01019,"16.3":0.04586,"16.4":0.00255,"16.5":0.01019,"16.6":0.11721,"17.0":0.01019,"17.1":0.07644,"17.2":0.01274,"17.3":0.01019,"17.4":0.02803,"17.5":0.04077,"17.6":0.21658,"18.0":0.03058,"18.1":0.15543,"18.2":0.0586,"18.3":1.07526,"18.4":0.01019},G:{"8":0,"3.2":0,"4.0-4.1":0,"4.2-4.3":0.00283,"5.0-5.1":0,"6.0-6.1":0.0085,"7.0-7.1":0.00567,"8.1-8.4":0,"9.0-9.2":0.00425,"9.3":0.01983,"10.0-10.2":0.00142,"10.3":0.03258,"11.0-11.2":0.15016,"11.3-11.4":0.00992,"12.0-12.1":0.00567,"12.2-12.5":0.14025,"13.0-13.1":0.00283,"13.2":0.00425,"13.3":0.00567,"13.4-13.7":0.01983,"14.0-14.4":0.04958,"14.5-14.8":0.0595,"15.0-15.1":0.03258,"15.2-15.3":0.03258,"15.4":0.03967,"15.5":0.04533,"15.6-15.8":0.55815,"16.0":0.07933,"16.1":0.16291,"16.2":0.085,"16.3":0.14733,"16.4":0.03258,"16.5":0.06091,"16.6-16.7":0.66156,"17.0":0.03967,"17.1":0.07083,"17.2":0.05383,"17.3":0.07508,"17.4":0.15016,"17.5":0.33432,"17.6-17.7":0.97039,"18.0":0.27199,"18.1":0.88964,"18.2":0.39807,"18.3":8.31984,"18.4":0.12325},P:{"4":0.03093,"20":0.01031,"21":0.01031,"22":0.01031,"23":0.01031,"24":0.02062,"25":0.04124,"26":0.05155,"27":1.40229,_:"5.0-5.4 6.2-6.4 8.2 9.2 10.1 12.0 14.0 15.0 16.0 17.0 18.0 19.0","7.2-7.4":0.02062,"11.1-11.2":0.01031,"13.0":0.01031},I:{"0":0.05205,"3":0,"4":0,"2.1":0,"2.2":0,"2.3":0,"4.1":0,"4.2-4.3":0.00002,"4.4":0,"4.4.3-4.4.4":0.00006},K:{"0":1.4904,_:"10 11 12 11.1 11.5 12.1"},A:{"11":0.02803,_:"6 7 8 9 10 5.5"},S:{_:"2.5 3.0-3.1"},J:{_:"7 10"},N:{_:"10 11"},R:{_:"0"},M:{"0":0.09688},Q:{_:"14.9"},O:{"0":3.99427},H:{"0":0},L:{"0":55.11172}};
|
||||
@@ -0,0 +1,146 @@
|
||||
'use strict';
|
||||
|
||||
var IDENTIFIER = /^[a-z_$][a-z0-9_$-]*$/i;
|
||||
var customRuleCode = require('./dotjs/custom');
|
||||
var definitionSchema = require('./definition_schema');
|
||||
|
||||
module.exports = {
|
||||
add: addKeyword,
|
||||
get: getKeyword,
|
||||
remove: removeKeyword,
|
||||
validate: validateKeyword
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Define custom keyword
|
||||
* @this Ajv
|
||||
* @param {String} keyword custom keyword, should be unique (including different from all standard, custom and macro keywords).
|
||||
* @param {Object} definition keyword definition object with properties `type` (type(s) which the keyword applies to), `validate` or `compile`.
|
||||
* @return {Ajv} this for method chaining
|
||||
*/
|
||||
function addKeyword(keyword, definition) {
|
||||
/* jshint validthis: true */
|
||||
/* eslint no-shadow: 0 */
|
||||
var RULES = this.RULES;
|
||||
if (RULES.keywords[keyword])
|
||||
throw new Error('Keyword ' + keyword + ' is already defined');
|
||||
|
||||
if (!IDENTIFIER.test(keyword))
|
||||
throw new Error('Keyword ' + keyword + ' is not a valid identifier');
|
||||
|
||||
if (definition) {
|
||||
this.validateKeyword(definition, true);
|
||||
|
||||
var dataType = definition.type;
|
||||
if (Array.isArray(dataType)) {
|
||||
for (var i=0; i<dataType.length; i++)
|
||||
_addRule(keyword, dataType[i], definition);
|
||||
} else {
|
||||
_addRule(keyword, dataType, definition);
|
||||
}
|
||||
|
||||
var metaSchema = definition.metaSchema;
|
||||
if (metaSchema) {
|
||||
if (definition.$data && this._opts.$data) {
|
||||
metaSchema = {
|
||||
anyOf: [
|
||||
metaSchema,
|
||||
{ '$ref': 'https://raw.githubusercontent.com/ajv-validator/ajv/master/lib/refs/data.json#' }
|
||||
]
|
||||
};
|
||||
}
|
||||
definition.validateSchema = this.compile(metaSchema, true);
|
||||
}
|
||||
}
|
||||
|
||||
RULES.keywords[keyword] = RULES.all[keyword] = true;
|
||||
|
||||
|
||||
function _addRule(keyword, dataType, definition) {
|
||||
var ruleGroup;
|
||||
for (var i=0; i<RULES.length; i++) {
|
||||
var rg = RULES[i];
|
||||
if (rg.type == dataType) {
|
||||
ruleGroup = rg;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (!ruleGroup) {
|
||||
ruleGroup = { type: dataType, rules: [] };
|
||||
RULES.push(ruleGroup);
|
||||
}
|
||||
|
||||
var rule = {
|
||||
keyword: keyword,
|
||||
definition: definition,
|
||||
custom: true,
|
||||
code: customRuleCode,
|
||||
implements: definition.implements
|
||||
};
|
||||
ruleGroup.rules.push(rule);
|
||||
RULES.custom[keyword] = rule;
|
||||
}
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Get keyword
|
||||
* @this Ajv
|
||||
* @param {String} keyword pre-defined or custom keyword.
|
||||
* @return {Object|Boolean} custom keyword definition, `true` if it is a predefined keyword, `false` otherwise.
|
||||
*/
|
||||
function getKeyword(keyword) {
|
||||
/* jshint validthis: true */
|
||||
var rule = this.RULES.custom[keyword];
|
||||
return rule ? rule.definition : this.RULES.keywords[keyword] || false;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Remove keyword
|
||||
* @this Ajv
|
||||
* @param {String} keyword pre-defined or custom keyword.
|
||||
* @return {Ajv} this for method chaining
|
||||
*/
|
||||
function removeKeyword(keyword) {
|
||||
/* jshint validthis: true */
|
||||
var RULES = this.RULES;
|
||||
delete RULES.keywords[keyword];
|
||||
delete RULES.all[keyword];
|
||||
delete RULES.custom[keyword];
|
||||
for (var i=0; i<RULES.length; i++) {
|
||||
var rules = RULES[i].rules;
|
||||
for (var j=0; j<rules.length; j++) {
|
||||
if (rules[j].keyword == keyword) {
|
||||
rules.splice(j, 1);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Validate keyword definition
|
||||
* @this Ajv
|
||||
* @param {Object} definition keyword definition object.
|
||||
* @param {Boolean} throwError true to throw exception if definition is invalid
|
||||
* @return {boolean} validation result
|
||||
*/
|
||||
function validateKeyword(definition, throwError) {
|
||||
validateKeyword.errors = null;
|
||||
var v = this._validateKeyword = this._validateKeyword
|
||||
|| this.compile(definitionSchema, true);
|
||||
|
||||
if (v(definition)) return true;
|
||||
validateKeyword.errors = v.errors;
|
||||
if (throwError)
|
||||
throw new Error('custom keyword definition is invalid: ' + this.errorsText(v.errors));
|
||||
else
|
||||
return false;
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
language: node_js
|
||||
node_js:
|
||||
- '0.10'
|
||||
@@ -0,0 +1,151 @@
|
||||
/**
|
||||
* @fileoverview Rule to enforce placing object properties on separate lines.
|
||||
* @author Vitor Balocco
|
||||
* @deprecated in ESLint v8.53.0
|
||||
*/
|
||||
|
||||
"use strict";
|
||||
|
||||
//------------------------------------------------------------------------------
|
||||
// Rule Definition
|
||||
//------------------------------------------------------------------------------
|
||||
|
||||
/** @type {import('../shared/types').Rule} */
|
||||
module.exports = {
|
||||
meta: {
|
||||
deprecated: {
|
||||
message: "Formatting rules are being moved out of ESLint core.",
|
||||
url: "https://eslint.org/blog/2023/10/deprecating-formatting-rules/",
|
||||
deprecatedSince: "8.53.0",
|
||||
availableUntil: "10.0.0",
|
||||
replacedBy: [
|
||||
{
|
||||
message:
|
||||
"ESLint Stylistic now maintains deprecated stylistic core rules.",
|
||||
url: "https://eslint.style/guide/migration",
|
||||
plugin: {
|
||||
name: "@stylistic/eslint-plugin-js",
|
||||
url: "https://eslint.style/packages/js",
|
||||
},
|
||||
rule: {
|
||||
name: "object-property-newline",
|
||||
url: "https://eslint.style/rules/js/object-property-newline",
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
type: "layout",
|
||||
|
||||
docs: {
|
||||
description: "Enforce placing object properties on separate lines",
|
||||
recommended: false,
|
||||
url: "https://eslint.org/docs/latest/rules/object-property-newline",
|
||||
},
|
||||
|
||||
schema: [
|
||||
{
|
||||
type: "object",
|
||||
properties: {
|
||||
allowAllPropertiesOnSameLine: {
|
||||
type: "boolean",
|
||||
default: false,
|
||||
},
|
||||
allowMultiplePropertiesPerLine: {
|
||||
// Deprecated
|
||||
type: "boolean",
|
||||
default: false,
|
||||
},
|
||||
},
|
||||
additionalProperties: false,
|
||||
},
|
||||
],
|
||||
|
||||
fixable: "whitespace",
|
||||
|
||||
messages: {
|
||||
propertiesOnNewlineAll:
|
||||
"Object properties must go on a new line if they aren't all on the same line.",
|
||||
propertiesOnNewline: "Object properties must go on a new line.",
|
||||
},
|
||||
},
|
||||
|
||||
create(context) {
|
||||
const allowSameLine =
|
||||
context.options[0] &&
|
||||
(context.options[0].allowAllPropertiesOnSameLine ||
|
||||
context.options[0]
|
||||
.allowMultiplePropertiesPerLine); /* Deprecated */
|
||||
const messageId = allowSameLine
|
||||
? "propertiesOnNewlineAll"
|
||||
: "propertiesOnNewline";
|
||||
|
||||
const sourceCode = context.sourceCode;
|
||||
|
||||
return {
|
||||
ObjectExpression(node) {
|
||||
if (allowSameLine) {
|
||||
if (node.properties.length > 1) {
|
||||
const firstTokenOfFirstProperty =
|
||||
sourceCode.getFirstToken(node.properties[0]);
|
||||
const lastTokenOfLastProperty = sourceCode.getLastToken(
|
||||
node.properties.at(-1),
|
||||
);
|
||||
|
||||
if (
|
||||
firstTokenOfFirstProperty.loc.end.line ===
|
||||
lastTokenOfLastProperty.loc.start.line
|
||||
) {
|
||||
// All keys and values are on the same line
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for (let i = 1; i < node.properties.length; i++) {
|
||||
const lastTokenOfPreviousProperty = sourceCode.getLastToken(
|
||||
node.properties[i - 1],
|
||||
);
|
||||
const firstTokenOfCurrentProperty =
|
||||
sourceCode.getFirstToken(node.properties[i]);
|
||||
|
||||
if (
|
||||
lastTokenOfPreviousProperty.loc.end.line ===
|
||||
firstTokenOfCurrentProperty.loc.start.line
|
||||
) {
|
||||
context.report({
|
||||
node,
|
||||
loc: firstTokenOfCurrentProperty.loc,
|
||||
messageId,
|
||||
fix(fixer) {
|
||||
const comma = sourceCode.getTokenBefore(
|
||||
firstTokenOfCurrentProperty,
|
||||
);
|
||||
const rangeAfterComma = [
|
||||
comma.range[1],
|
||||
firstTokenOfCurrentProperty.range[0],
|
||||
];
|
||||
|
||||
// Don't perform a fix if there are any comments between the comma and the next property.
|
||||
if (
|
||||
sourceCode.text
|
||||
.slice(
|
||||
rangeAfterComma[0],
|
||||
rangeAfterComma[1],
|
||||
)
|
||||
.trim()
|
||||
) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return fixer.replaceTextRange(
|
||||
rangeAfterComma,
|
||||
"\n",
|
||||
);
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
},
|
||||
};
|
||||
},
|
||||
};
|
||||
Reference in New Issue
Block a user