feat: Add TypeScript typings

Author: prantlf

.eslintignore

@@ -5,4 +5,5 @@ test/fails
 test/passes
 test/recursive
 test/v8
+test/typings.test.js
 web/*.min.*

.gitignore

@@ -1,8 +1,10 @@
+.DS_Store
 .nyc_output
 benchmarks/jison/*.js
 benchmarks/pegjs/*.js
 coverage
 node_modules
 lib/jsonlint*.js
 lib/schema-drafts.js
+test/typings.test.js
 web/*.min.*

.npmignore

@@ -12,4 +12,5 @@ coverage
 scripts
 src
 test
+tslint.yml
 web/*.html

lib/jsonlint.d.ts

@@ -0,0 +1,60 @@
+type ParseMode = 'json' | 'cjson' | 'json5'
+
+interface ParseOptions {
+  ignoreComments?: boolean
+  ignoreTrailingCommas?: boolean
+  allowSingleQuotedStrings?: boolean
+  allowDuplicateObjectKeys?: boolean
+  mode?: ParseMode
+  reviver?: Function
+}
+
+/**
+ * Parses a string formatted as JSON. It is compatible with the native
+ * `JSON.parse` method.
+ *
+ * @example
+ * ```ts
+ * import { parse } from '@prantlf/jsonlint'
+ * const parsed = parse('string with JSON data')
+ * ```
+ *
+ * @param input - a string input to parse
+ * @param reviverOrOptions - either a value reviver or an object
+ *                           with multiple options
+ * @returns the parsed result - a primitive value, array or object
+ */
+declare function parse (input: string, reviverOrOptions?: Function | ParseOptions): object
+
+declare module '@prantlf/jsonlint/lib/validator' {
+  type Environment = 'json-schema-draft-04' | 'json-schema-draft-06' | 'json-schema-draft-07'
+
+  interface CompileOptions {
+    ignoreComments?: boolean
+    ignoreTrailingCommas?: boolean
+    allowSingleQuotedStrings?: boolean
+    allowDuplicateObjectKeys?: boolean
+    environment?: Environment
+    mode?: ParseMode
+  }
+
+  /**
+   * Generates a JSON Schema validator.
+   *
+   * @example
+   * ```ts
+   * import { compile } from '@prantlf/jsonlint/lib/validator'
+   * const validate = compile('string with JSON schema')
+   * const parsed = validate('string with JSON data')
+   * ```
+   *
+   * @param schema - a string with the JSON Schema to validate with
+   * @param environmentOrOptions - either a string with the version
+   *                               of the JSON Schema standard or an object
+   *                               with multiple options
+   * @returns the validator function
+   */
+  function compile (schema: string, environmentOrOptions?: Environment | CompileOptions): Function
+}
+
+export { parse }

package-lock.json

@@ -25,6 +25,7 @@
   },
   "preferGlobal": true,
   "main": "lib/jsonlint.js",
+  "typings": "lib/jsonlint.d.ts",
   "bin": {
     "jsonlint": "lib/cli.js"
   },
@@ -33,11 +34,13 @@
   },
   "scripts": {
     "prepare": "npm run lint && npm run build",
-    "lint": "standard --fix -v",
-    "build": "node scripts/bundle-jsonlint && uglifyjs -o web/jsonlint.min.js --source-map \"filename='jsonlint.js',url='jsonlint.min.js.map',includeSources=true\" lib/jsonlint.js && uglifyjs -o web/validator.min.js --source-map \"filename='validator.js',url='validator.min.js.map',includeSources=true\" lib/validator.js && uglifyjs -o web/formatter.min.js --source-map \"filename='formatter.js',url='formatter.min.js.map',includeSources=true\" lib/formatter.js && uglifyjs -o web/sorter.min.js --source-map \"filename='sorter.js',url='sorter.min.js.map',includeSources=true\" lib/sorter.js && node scripts/bundle-schema-drafts && uglifyjs -o web/schema-drafts.min.js --source-map \"filename='schema-drafts.js',url='schema-drafts.min.js.map',includeSources=true\" lib/schema-drafts.js && uglifyjs -o web/ajv.min.js --source-map \"filename='ajv.js',url='ajv.min.js.map',includeSources=true\" node_modules/ajv/dist/ajv.bundle.js",
-    "test": "nyc --silent node test/parse1 && nyc --silent --no-clean node test/parse1 --native-parser && nyc --silent --no-clean node test/parse2 && nyc --silent --no-clean node test/parse3 && nyc --silent --no-clean node test/parse4 && nyc --silent --no-clean node test/parse5 && nyc --silent --no-clean node test/portable && nyc --silent --no-clean node lib/cli package.json test/recursive && nyc --silent --no-clean node lib/cli -sq test/passes/hasOwnProperty.json && nyc --silent --no-clean node lib/cli -s -e json-schema-draft-04 -V test/passes/3.schema.json test/passes/3.json && nyc --silent --no-clean node lib/cli -C test/passes/comments.txt && nyc --silent --no-clean node lib/cli -S test/passes/strings.txt && nyc --silent --no-clean node lib/cli -M json5 test/passes/json5.text && nyc --silent --no-clean node lib/cli -v && nyc --silent --no-clean node lib/cli -h && nyc --silent --no-clean node lib/cli -pc test/fails/10.json || nyc report",
-    "test:old": "node test/parse1 && node test/parse1 --native-parser && node test/parse2 && node test/parse3 && node test/parse4 && node test/parse5 && node test/portable && node lib/cli package.json test/recursive && node lib/cli -sq test/passes/hasOwnProperty.json && node lib/cli -s -e json-schema-draft-04 -V test/passes/3.schema.json test/passes/3.json && node lib/cli -C test/passes/comments.txt && node lib/cli -S test/passes/strings.txt && node lib/cli -M json5 test/passes/json5.text && node lib/cli -v && node lib/cli -h",
-    "coverage": "cat coverage/lcov.info | npx coveralls",
+    "lint": "npm run lint:js && npm run lint:ts",
+    "lint:js": "standard --fix -v",
+    "lint:ts": "tslint --fix -t stylish lib/*.ts test/*.ts",
+    "build": "npm run compile && npm run compile:tests",
+    "compile": "node scripts/bundle-jsonlint && uglifyjs -o web/jsonlint.min.js --source-map \"filename='jsonlint.js',url='jsonlint.min.js.map',includeSources=true\" lib/jsonlint.js && uglifyjs -o web/validator.min.js --source-map \"filename='validator.js',url='validator.min.js.map',includeSources=true\" lib/validator.js && uglifyjs -o web/formatter.min.js --source-map \"filename='formatter.js',url='formatter.min.js.map',includeSources=true\" lib/formatter.js && uglifyjs -o web/sorter.min.js --source-map \"filename='sorter.js',url='sorter.min.js.map',includeSources=true\" lib/sorter.js && node scripts/bundle-schema-drafts && uglifyjs -o web/schema-drafts.min.js --source-map \"filename='schema-drafts.js',url='schema-drafts.min.js.map',includeSources=true\" lib/schema-drafts.js && uglifyjs -o web/ajv.min.js --source-map \"filename='ajv.js',url='ajv.min.js.map',includeSources=true\" node_modules/ajv/dist/ajv.bundle.js",
+    "compile:tests": "tsc --lib es6 test/typings.test.ts",
+    "test": "nyc --silent node test/typings.test.js && nyc --silent --no-clean node test/parse1 && nyc --silent --no-clean node test/parse1 --native-parser && nyc --silent --no-clean node test/parse2 && nyc --silent --no-clean node test/parse3 && nyc --silent --no-clean node test/parse4 && nyc --silent --no-clean node test/parse5 && nyc --silent --no-clean node test/portable && nyc --silent --no-clean node lib/cli package.json test/recursive && nyc --silent --no-clean node lib/cli -sq test/passes/hasOwnProperty.json && nyc --silent --no-clean node lib/cli -s -e json-schema-draft-04 -V test/passes/3.schema.json test/passes/3.json && nyc --silent --no-clean node lib/cli -C test/passes/comments.txt && nyc --silent --no-clean node lib/cli -S test/passes/strings.txt && nyc --silent --no-clean node lib/cli -M json5 test/passes/json5.text && nyc --silent --no-clean node lib/cli -v && nyc --silent --no-clean node lib/cli -h && nyc --silent --no-clean node lib/cli -pc test/fails/10.json || nyc report",
     "start": "http-server -c 5",
     "web": "npm run web:sync && npm run web:deploy",
     "web:clone": "test ! -d ../jsonlint-pages && git clone --single-branch --branch gh-pages `git remote get-url origin` ../jsonlint-pages",
@@ -67,11 +70,15 @@
     "commander": "4.0.1"
   },
   "devDependencies": {
+    "@types/node": "12.12.21",
     "http-server": "0.12.0",
     "js-yaml": "3.13.1",
     "nyc": "14.1.1",
     "standard": "14.3.1",
     "test": "0.6.0",
+    "tslint": "5.20.1",
+    "tslint-config-standard": "9.0.0",
+    "typescript": "3.7.4",
     "uglify-js": "3.7.2"
   }
 }

package.json

@@ -0,0 +1,45 @@
+import { strict as assert } from 'assert'
+import { parse } from '..'
+import { compile } from '../lib/validator'
+
+exports['test type declarations for parse'] = () => {
+  const result = parse('{}')
+  assert.equal(typeof result, 'object')
+  parse('{}', () => undefined)
+  parse('{}', {})
+  parse('{}', { mode: 'json' })
+  parse('{}', { mode: 'cjson' })
+  parse('{}', { mode: 'json5' })
+  parse('{}', {
+    ignoreComments: true,
+    ignoreTrailingCommas: true,
+    allowSingleQuotedStrings: true,
+    allowDuplicateObjectKeys: true,
+    reviver: () => undefined
+  })
+  assert.ok(true)
+}
+
+exports['test type declarations for compile'] = () => {
+  const validate = compile('{}')
+  assert.equal(typeof validate, 'function')
+  compile('{}', 'json-schema-draft-04')
+  compile('{}', 'json-schema-draft-06')
+  compile('{}', 'json-schema-draft-07')
+  compile('{}', {})
+  compile('{}', { mode: 'json' })
+  compile('{}', { mode: 'cjson' })
+  compile('{}', { mode: 'json5' })
+  compile('{}', { environment: 'json-schema-draft-04' })
+  compile('{}', { environment: 'json-schema-draft-06' })
+  compile('{}', { environment: 'json-schema-draft-07' })
+  compile('{}', {
+    ignoreComments: true,
+    ignoreTrailingCommas: true,
+    allowSingleQuotedStrings: true,
+    allowDuplicateObjectKeys: true
+  })
+  assert.ok(true)
+}
+
+if (require.main === module) { require('test').run(exports) }

test/typings.test.ts

@@ -0,0 +1 @@
+extends: tslint-config-standard