Refs #28: [Proposal] Updates, fixes and new features

.eslintrc.json

@@ -263,7 +263,6 @@
         "@typescript-eslint/consistent-type-assertions": "error",
         "@typescript-eslint/no-array-constructor": "error",
         "@typescript-eslint/no-namespace": "error",
-        "@typescript-eslint/no-parameter-properties": "error",
         "@typescript-eslint/triple-slash-reference": "error",
         "@typescript-eslint/no-unused-vars": "off",
         "@typescript-eslint/no-use-before-define": "error",

.gitignore

@@ -24,7 +24,7 @@ node_modules/
 .vscode
 
 # Compiled files
-dist/
+dist/tests
 
 # Test output
 .nyc_output/

README.md

@@ -26,11 +26,17 @@ markdown-link-validator ./path/to/mds [options]
 
 Basic configuration:
   -i, --ignorePatterns path::[String]  Regex to ignore links - default: []
-  -f, --flags path::String  Flags applied to the ignore pattern
-  -h, --help                Show help
+  --ignorePatternsFromFile String      File containing regex to ignore links (see --ignorePatterns option), one per line
+  -f, --flags path::String             Flags applied to the ignore patterns
+  -c, --ignoreStatusCodes [Number]     HTTP status code of valid links - default: [200]
+  -e, --optionalMdExtension Boolean    File extension (.md) is optional for relative links, that can be also folders with an index.md file inside#
+  -o, --allowOtherExtensions Boolean   Relative links are valid also with extensions other than .md, including images
+  --noEmptyFiles Boolean               Links to empty files are invalid (shown as errors instead of warnings in report)
+  -q, --quietMode Boolean              Show only errors and warnings in report
+  -h, --help                           Show help
 
 Miscellaneous:
-  --debug                   Output debugging information
+  --debug                              Output debugging information
 ```
 
 The following will analyze all the `.md` files found under `./docs` and

dist/src/bin/markdown-link-validator.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+/**
+ * @fileoverview Main CLI that is run via the markdown-link-validator command.
+ * Based on ESLint.
+ */
+export {};

dist/src/lib/cli.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @fileoverview Main CLI object, it reads the options from cli.
+ */
+declare const _default: {
+    execute: (args: string[]) => Promise<0 | 1>;
+};
+export default _default;

dist/src/lib/cli/options.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @fileoverview Options configuration for optionator.
+ */
+export declare const options: any;