Add example code copile to package.json

package.json

@@ -22,14 +22,16 @@
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "scripts": {
-        "clean": "rimraf dist",
+        "clean": "rimraf dist coverage",
         "build": "tsc -p tsconfig.build.json",
+        "build:example": "tsc -p src/example",
+        "watch-build:example": "tsc -p src/example --watch",
         "watch-build": "tsc --watch -p tsconfig.build.json",
         "lint": "eslint . --ext .ts",
         "test": "jest --ci --coverage && tsc --noemit",
         "watch-test": "jest --watch",
         "prebuild-release": "npm run clean",
-        "build-release": "concurrently --kill-others-on-fail npm:test npm:lint npm:build npm:verify-markdown && codecov",
+        "build-release": "concurrently --kill-others-on-fail npm:test npm:lint npm:build npm:build:example npm:verify-markdown && codecov",
         "prewrite-markdown": "npm run build",
         "preverify-markdown": "npm run build",
         "write-markdown": "node dist/write-markdown -f package.json -p markdownConfig",

src/example/additionalModifiers.ts

@@ -1,4 +1,4 @@
-import { parse } from '../parse';
+import { parse } from '../';
 import { additionalModifiers } from './configs';
 
 const args = parse(additionalModifiers.arguments, additionalModifiers.parseOptions);

src/example/configs.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-useless-escape */
-import { ArgumentConfig, UsageGuideConfig } from '../contracts';
+import { ArgumentConfig, UsageGuideConfig } from '../';
 
 /**
  * we do not have any side effects in this file as this file is required by write-markdown

src/example/exampleConfig.ts

@@ -1,4 +1,4 @@
-import { parse } from '../parse';
+import { parse } from '../';
 import { argumentConfig } from './configs';
 
 const args = parse(argumentConfig);

src/example/exampleConfigHelpWithMissingArgs.ts

@@ -1,5 +1,4 @@
-import { CommandLineOption } from '../contracts';
-import { parse } from '../parse';
+import { parse, CommandLineOption } from '../';
 import { argumentConfig } from './configs';
 
 const args = parse(argumentConfig, {

src/example/exampleConfigUsingPrintHelp.ts

@@ -1,4 +1,4 @@
-import { parse } from '../parse';
+import { parse } from '../';
 import { argumentConfig } from './configs';
 
 const args = parse(argumentConfig, { hideMissingArgMessages: true }, false, true);

src/example/exampleConfigWithHelp.ts

@@ -1,4 +1,4 @@
-import { parse } from '../parse';
+import { parse } from '../';
 
 interface ICopyFilesArguments {
     sourcePath?: string;

src/example/exitProcessExample.ts

@@ -1,4 +1,4 @@
-import { parse } from '../parse';
+import { parse } from '../';
 import { argumentConfig } from './configs';
 
 /**

src/example/noExitProcessExample.ts

@@ -1,5 +1,5 @@
 import { argumentConfig } from './configs';
-import { parse } from '../parse';
+import { parse } from '../';
 
 /**
  * will ignore missing errors and not exit

src/example/tsconfig.json

@@ -0,0 +1,6 @@
+{
+    "extends": "../../tsconfig.json",
+    "compilerOptions": {
+        "declaration": false,
+    }
+}

src/example/typicalAppWithGroups.ts

@@ -1,4 +1,4 @@
-import { parse } from '../parse';
+import { parse } from '../';
 import { typicalAppWithGroupsInfo } from './configs';
 
 const args = parse(typicalAppWithGroupsInfo.arguments, typicalAppWithGroupsInfo.parseOptions);

src/example/unknownArgumentsExample.ts

@@ -1,4 +1,4 @@
-import { parse } from '../parse';
+import { parse } from '../';
 import { argumentConfig } from './configs';
 
 /**

src/example/usageGuideWithExamples.ts

@@ -1,4 +1,4 @@
-import { parse } from '../parse';
+import { parse } from '../';
 import { exampleSections } from './configs';
 
 const args = parse(exampleSections.arguments, exampleSections.parseOptions);

tsconfig.build.json

@@ -2,6 +2,7 @@
     "extends": "./tsconfig.json",
     "exclude": [
         "src/**/*.spec.ts",
-        "dist"
+        "dist",
+        "src/example/**/*"
     ]
 }