Convert project to TypeScript

Author: Cellule

.eslintrc.json

@@ -1 +1,3 @@
 node_modules/
+index.js
+index.d.ts

.gitignore

@@ -2,3 +2,6 @@ node_modules/
 test/
 .eslintrc.json
 .git*
+*.ts
+!*.d.ts
+tsconfig.json

.npmignore

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.3.0 (2019-04-16)
+**Dev Experience Changes**
+- Project now compiled with TypeScript and provides typings
+
 ## v0.2.0 (2019-04-14)
 **Parsing Behavior Changes**
 - Now parses multiple nested quotes and content when there are no spaces [7d9b897](https://github.com/mccormicka/string-argv/commit/7d9b89730ea112b829f2591e3e9cae4c0d0cc285)

CHANGELOG.md

@@ -1,33 +1,33 @@
-"use strict";
 
-module.exports = parseArgsStringToArgv;
-module.exports.parseArgsStringToArgv = parseArgsStringToArgv;
-
-function parseArgsStringToArgv(value, env, file) {
+export { parseArgsStringToArgv as default, parseArgsStringToArgv };
+function parseArgsStringToArgv(
+  value: string,
+  env?: string,
+  file?: string
+): string[] {
   // ([^\s'"]([^\s'"]*(['"])([^\3]*?)\3)+[^\s'"]*) Matches nested quotes until the first space outside of quotes
 
   // [^\s'"]+ or Match if not a space ' or "
 
   // (['"])([^\5]*?)\5 or Match "quoted text" without quotes
   // `\3` and `\5` are a backreference to the quote style (' or ") captured
-  var myRegexp = /([^\s'"]([^\s'"]*(['"])([^\3]*?)\3)+[^\s'"]*)|[^\s'"]+|(['"])([^\5]*?)\5/gi;
-  var myString = value;
-  var myArray = [
-  ];
+  const myRegexp = /([^\s'"]([^\s'"]*(['"])([^\3]*?)\3)+[^\s'"]*)|[^\s'"]+|(['"])([^\5]*?)\5/gi;
+  const myString = value;
+  const myArray: string[] = [];
   if (env) {
     myArray.push(env);
   }
   if (file) {
     myArray.push(file);
   }
-  var match;
+  let match: RegExpExecArray | null;
   do {
         // Each call to exec returns the next regex match as an array
     match = myRegexp.exec(myString);
     if (match !== null) {
       // Index 1 in the array is the captured group if it exists
       // Index 0 is the matched text, which we use if no captured group exists
-      myArray.push(firstString(match[1], match[6], match[0]));
+      myArray.push(firstString(match[1], match[6], match[0])!);
     }
   } while (match !== null);
 
@@ -36,9 +36,9 @@ function parseArgsStringToArgv(value, env, file) {
 
 // Accepts any number of arguments, and returns the first one that is a string
 // (even an empty string)
-function firstString() {
-  for (var i = 0; i < arguments.length; i++) {
-    var arg = arguments[i];
+function firstString(...args: Array<any>): string | undefined {
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
     if (typeof arg === "string") {
       return arg;
     }

index.js renamed to index.ts

@@ -1,7 +1,7 @@
 {
   "name": "string-argv",
   "description": "string-argv parses a string into an argument array to mimic process.argv. This is useful when testing Command Line Utilities that you want to pass arguments to.",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "contributors": [
     {
       "name": "Michael Ferris",
@@ -17,10 +17,12 @@
     "argv"
   ],
   "scripts": {
-    "lint": "eslint .",
-    "test": "jasmine --config=test/config.json && npm run lint"
+    "build": "tsc -p .",
+    "prepublishOnly": "npm test",
+    "test": "npm run build & jasmine --config=test/config.json"
   },
   "main": "index",
+  "types": "index.d.ts",
   "engines": {
     "node": ">=0.6.19"
   },
@@ -35,8 +37,7 @@
   "readmeFilename": "README.md",
   "dependencies": {},
   "devDependencies": {
-    "eslint": "^2.0.0",
-    "eslint-config-cellule": "^3.0.0",
-    "jasmine": "^2.4.1"
+    "jasmine": "^2.4.1",
+    "typescript": "^3.4.3"
   }
 }

package-lock.json

@@ -0,0 +1,62 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "es3",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    // "outDir": "./",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "incremental": true,                   /* Enable incremental compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+  }
+}