@oclif/core 1.4.0 → 1.5.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.5.0](https://github.com/oclif/core/compare/v1.4.0...v1.5.0) (2022-03-02)
+
+
+### Features
+
+* dir and file flags that validate existence and type ([#384](https://github.com/oclif/core/issues/384)) ([44dff41](https://github.com/oclif/core/commit/44dff41c5a3ffcdcbf2f10dcefb7c1ab233bfc4f))
+
 ## [1.4.0](https://github.com/oclif/core/compare/v1.3.6...v1.4.0) (2022-03-01)
 
 

package/lib/flags.d.ts

@@ -10,6 +10,6 @@ declare const _enum: <T = string>(opts: EnumFlagOptions<T>) => OptionFlag<T>;
 export { _enum as enum };
 declare const stringFlag: Definition<string>;
 export { stringFlag as string };
-export { boolean, integer, url } from './parser';
+export { boolean, integer, url, directory, file } from './parser';
 export declare const version: (opts?: Partial<BooleanFlag<boolean>>) => BooleanFlag<void>;
 export declare const help: (opts?: Partial<BooleanFlag<boolean>>) => BooleanFlag<void>;

package/lib/flags.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.help = exports.version = exports.url = exports.integer = exports.boolean = exports.string = exports.enum = exports.option = exports.build = void 0;
+exports.help = exports.version = exports.file = exports.directory = exports.url = exports.integer = exports.boolean = exports.string = exports.enum = exports.option = exports.build = void 0;
 const Parser = require("./parser");
 function build(defaults) {
     return Parser.flags.build(defaults);
@@ -28,6 +28,8 @@ var parser_1 = require("./parser");
 Object.defineProperty(exports, "boolean", { enumerable: true, get: function () { return parser_1.boolean; } });
 Object.defineProperty(exports, "integer", { enumerable: true, get: function () { return parser_1.integer; } });
 Object.defineProperty(exports, "url", { enumerable: true, get: function () { return parser_1.url; } });
+Object.defineProperty(exports, "directory", { enumerable: true, get: function () { return parser_1.directory; } });
+Object.defineProperty(exports, "file", { enumerable: true, get: function () { return parser_1.file; } });
 const version = (opts = {}) => {
     return Parser.flags.boolean({
         description: 'Show CLI version.',

package/lib/interfaces/index.d.ts

@@ -6,7 +6,7 @@ export { HelpOptions } from './help';
 export { Hook, Hooks } from './hooks';
 export { Manifest } from './manifest';
 export { S3Manifest } from './s3-manifest';
-export { ParserArg, Arg, ParseFn, ParserOutput, ParserInput, ArgToken, OptionalArg, FlagOutput, OutputArgs, OutputFlags, FlagUsageOptions, CLIParseErrorOptions, ArgInput, RequiredArg, Metadata, ParsingToken, FlagToken, List, ListItem, BooleanFlag, Flag, FlagBase, OptionFlag, Input, EnumFlagOptions, DefaultContext, Default, Definition, CompletableOptionFlag, Completion, CompletionContext, FlagInput, CompletableFlag, } from './parser';
+export { ParserArg, Arg, ParseFn, ParserOutput, ParserInput, ArgToken, OptionalArg, FlagOutput, OutputArgs, OutputFlags, FlagUsageOptions, CLIParseErrorOptions, ArgInput, RequiredArg, Metadata, ParsingToken, FlagToken, List, ListItem, BooleanFlag, Flag, FlagBase, OptionFlag, Input, EnumFlagOptions, DefaultContext, Default, Definition, CompletableOptionFlag, Completion, CompletionContext, FlagInput, CompletableFlag, OptionFlagProps, } from './parser';
 export { PJSON } from './pjson';
 export { Plugin, PluginOptions, Options } from './plugin';
 export { Topic } from './topic';

package/lib/parser/flags.d.ts

@@ -7,6 +7,12 @@ export declare function build<T>(defaults: {
 export declare function build(defaults: Partial<OptionFlag<string>>): Definition<string>;
 export declare function boolean<T = boolean>(options?: Partial<BooleanFlag<T>>): BooleanFlag<T>;
 export declare const integer: Definition<number>;
+export declare const directory: (opts?: {
+    exists?: boolean;
+} & Partial<OptionFlag<string>>) => OptionFlag<string | undefined>;
+export declare const file: (opts?: {
+    exists?: boolean;
+} & Partial<OptionFlag<string>>) => OptionFlag<string | undefined>;
 /**
  * Initializes a string as a URL. Throws an error
  * if the string is not a valid URL.

package/lib/parser/flags.js

@@ -1,8 +1,9 @@
 "use strict";
 // tslint:disable interface-over-type-literal
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultFlags = exports.string = exports.option = exports.url = exports.integer = exports.boolean = exports.build = void 0;
+exports.defaultFlags = exports.string = exports.option = exports.url = exports.file = exports.directory = exports.integer = exports.boolean = exports.build = void 0;
 const url_1 = require("url");
+const fs = require("fs");
 function build(defaults) {
     return (options = {}) => {
         return {
@@ -32,6 +33,20 @@ exports.integer = build({
         return Number.parseInt(input, 10);
     },
 });
+const directory = (opts = {}) => {
+    return build({
+        ...opts,
+        parse: async (input) => opts.exists ? dirExists(input) : input,
+    })();
+};
+exports.directory = directory;
+const file = (opts = {}) => {
+    return build({
+        ...opts,
+        parse: async (input) => opts.exists ? fileExists(input) : input,
+    })();
+};
+exports.file = file;
 /**
  * Initializes a string as a URL. Throws an error
  * if the string is not a valid URL.
@@ -55,3 +70,21 @@ exports.string = stringFlag;
 exports.defaultFlags = {
     color: boolean({ allowNo: true }),
 };
+const dirExists = async (input) => {
+    if (!fs.existsSync(input)) {
+        throw new Error(`No directory found at ${input}`);
+    }
+    if (!(await fs.promises.stat(input)).isDirectory()) {
+        throw new Error(`${input} exists but is not a directory`);
+    }
+    return input;
+};
+const fileExists = async (input) => {
+    if (!fs.existsSync(input)) {
+        throw new Error(`No file found at ${input}`);
+    }
+    if (!(await fs.promises.stat(input)).isFile()) {
+        throw new Error(`${input} exists but is not a file`);
+    }
+    return input;
+};

package/lib/parser/index.d.ts

@@ -8,5 +8,9 @@ export { flagUsages } from './help';
 export declare function parse<TFlags, TArgs extends {
     [name: string]: string;
 }>(argv: string[], options: Input<TFlags>): Promise<ParserOutput<TFlags, TArgs>>;
-declare const boolean: typeof flags.boolean, integer: import("../interfaces").Definition<number>, url: import("../interfaces").Definition<import("url").URL>;
-export { boolean, integer, url };
+declare const boolean: typeof flags.boolean, integer: import("../interfaces").Definition<number>, url: import("../interfaces").Definition<import("url").URL>, directory: (opts?: {
+    exists?: boolean | undefined;
+} & Partial<import("../interfaces").OptionFlag<string>>) => import("../interfaces").OptionFlag<string | undefined>, file: (opts?: {
+    exists?: boolean | undefined;
+} & Partial<import("../interfaces").OptionFlag<string>>) => import("../interfaces").OptionFlag<string | undefined>;
+export { boolean, integer, url, directory, file };

package/lib/parser/index.js

@@ -1,7 +1,7 @@
 "use strict";
 // tslint:disable interface-over-type-literal
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = exports.integer = exports.boolean = exports.parse = exports.flagUsages = exports.flags = exports.args = void 0;
+exports.file = exports.directory = exports.url = exports.integer = exports.boolean = exports.parse = exports.flagUsages = exports.flags = exports.args = void 0;
 const args = require("./args");
 exports.args = args;
 const deps_1 = require("./deps");
@@ -32,7 +32,9 @@ async function parse(argv, options) {
     return output;
 }
 exports.parse = parse;
-const { boolean, integer, url } = flags;
+const { boolean, integer, url, directory, file } = flags;
 exports.boolean = boolean;
 exports.integer = integer;
 exports.url = url;
+exports.directory = directory;
+exports.file = file;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {