@henderea/arg-helper 1.2.3 → 1.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@henderea/arg-helper",
3
- "version": "1.2.3",
3
+ "version": "1.2.5",
4
4
  "description": "A utility wrapper around the arg command-line parser",
5
5
  "main": "src/index.js",
6
6
  "types": "src/index.d.ts",
@@ -8,8 +8,8 @@
8
8
  "author": "Eric Henderson <henderea@gmail.com>",
9
9
  "license": "MIT",
10
10
  "scripts": {
11
- "lint": "eslint src --ext .js",
12
- "lint:fix": "eslint --fix src --ext .js"
11
+ "lint": "eslint src",
12
+ "lint:fix": "eslint --fix src"
13
13
  },
14
14
  "peerDependencies": {
15
15
  "arg": "5.x"
@@ -18,17 +18,20 @@
18
18
  "escalade": "^3.1.1"
19
19
  },
20
20
  "devDependencies": {
21
- "@typescript-eslint/eslint-plugin": "^5.58.0",
22
- "@typescript-eslint/parser": "^5.58.0",
23
- "eslint": "^8.38.0",
24
- "eslint-config-henderea": "1.1.7",
25
- "eslint-plugin-import": "^2.27.5",
26
- "typescript": "^5.0.4"
21
+ "@typescript-eslint/eslint-plugin": "^6.8.0",
22
+ "@typescript-eslint/parser": "^6.8.0",
23
+ "eslint": "^8.51.0",
24
+ "eslint-config-henderea": "1.1.17",
25
+ "eslint-plugin-import": "^2.28.1",
26
+ "typescript": "^5.2.2"
27
27
  },
28
28
  "files": [
29
29
  "src/**/*"
30
30
  ],
31
31
  "eslintConfig": {
32
- "extends": "henderea"
32
+ "extends": "henderea",
33
+ "rules": {
34
+ "@typescript-eslint/ban-types": 0
35
+ }
33
36
  }
34
37
  }
package/src/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- declare function argHelper(arg: any): {argParser: argHelper.argParser};
1
+ declare function argHelper(arg: any): { argParser: argHelper.argParser };
2
2
 
3
3
  declare namespace argHelper {
4
4
  export interface Map<V> {
@@ -18,11 +18,15 @@ declare namespace argHelper {
18
18
  helpText(helpText: string, ...names: Array<string>): this;
19
19
  findVersion(callerPath: string, ...names: Array<string>): this;
20
20
  version(packageJsonFile: string, ...names: Array<string>): this;
21
+ withVersion(version: string, ...names: Array<string>): this;
21
22
  parse(argv?: Array<any> | null): Map<any>;
22
- readonly argv: Map<any>;
23
+ get argv(): Map<any>;
23
24
  }
24
25
 
25
- export type argParser = () => ArgParser;
26
+ export interface argParser {
27
+ (): ArgParser;
28
+ terminalWidth(multiplier?: number): number;
29
+ }
26
30
  }
27
31
 
28
- export = argHelper;
32
+ export = argHelper;
package/src/index.js CHANGED
@@ -8,6 +8,7 @@ class ArgParser {
8
8
  this._names = {};
9
9
  this._helpText = null;
10
10
  this._packageJsonFile = null;
11
+ this._version = null;
11
12
  }
12
13
 
13
14
  flag(name, ...names) {
@@ -49,6 +50,10 @@ class ArgParser {
49
50
  this._packageJsonFile = packageJsonFile;
50
51
  return this.bool('version', ...names);
51
52
  }
53
+ withVersion(version, ...names) {
54
+ this._version = version;
55
+ return this.bool('version', ...names);
56
+ }
52
57
 
53
58
  parse(argv = null) {
54
59
  let config = { permissive: true };
@@ -65,11 +70,16 @@ class ArgParser {
65
70
  console.log(this._helpText);
66
71
  process.exit(0);
67
72
  }
68
- if(rv.version && this._packageJsonFile && fs.existsSync(this._packageJsonFile)) {
69
- const packageJson = JSON.parse(fs.readFileSync(this._packageJsonFile));
70
- const version = packageJson.version;
71
- if(version) {
72
- console.log(version);
73
+ if(rv.version) {
74
+ if(this._packageJsonFile && fs.existsSync(this._packageJsonFile)) {
75
+ const packageJson = JSON.parse(fs.readFileSync(this._packageJsonFile));
76
+ const version = packageJson.version;
77
+ if(version) {
78
+ console.log(version);
79
+ process.exit(0);
80
+ }
81
+ } else if(this._version) {
82
+ console.log(this._version);
73
83
  process.exit(0);
74
84
  }
75
85
  }
@@ -79,8 +89,18 @@ class ArgParser {
79
89
  get argv() {
80
90
  return this.parse();
81
91
  }
92
+
93
+ static terminalWidth(multiplier = 1) {
94
+ const cols = process.stdout.columns;
95
+ if(cols) {
96
+ return Math.round(cols * multiplier);
97
+ }
98
+ return undefined;
99
+ }
82
100
  }
83
101
 
84
102
  module.exports = (arg) => {
85
- return { argParser: () => new ArgParser(arg) };
103
+ const argParser = () => new ArgParser(arg);
104
+ argParser.terminalWidth = ArgParser.terminalWidth;
105
+ return { argParser };
86
106
  };