Merge branch 'master' into patch-1

Author: epoberezkin

.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: build
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: ["*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org/
+      - run: npm install
+      - run: npm test
+      - name: Publish beta version to npm
+        if: "github.event.release.prerelease"
+        run: npm publish --tag beta
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Publish to npm
+        if: "!github.event.release.prerelease"
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.travis.yml

@@ -2,15 +2,14 @@
 
 Custom error messages in JSON-Schema for Ajv validator
 
-[![Build Status](https://travis-ci.org/ajv-validator/ajv-errors.svg?branch=master)](https://travis-ci.org/ajv-validator/ajv-errors)
+[![build](https://github.com/ajv-validator/ajv-errors/workflows/build/badge.svg)](https://github.com/ajv-validator/ajv-errors/actions?query=workflow%3Abuild)
 [![npm](https://img.shields.io/npm/v/ajv-errors.svg)](https://www.npmjs.com/package/ajv-errors)
-[![npm (beta)](https://img.shields.io/npm/v/ajv-errors/beta)](https://www.npmjs.com/package/ajv-errors/v/2.0.0-beta.0)
-[![Coverage Status](https://coveralls.io/repos/github/ajv-validator/ajv-errors/badge.svg?branch=master)](https://coveralls.io/github/ajv-validator/ajv-errors?branch=master)
-[![Gitter](https://img.shields.io/gitter/room/ajv-validator/ajv.svg)](https://gitter.im/ajv-validator/ajv)
+[![coverage](https://coveralls.io/repos/github/ajv-validator/ajv-errors/badge.svg?branch=master)](https://coveralls.io/github/ajv-validator/ajv-errors?branch=master)
+[![gitter](https://img.shields.io/gitter/room/ajv-validator/ajv.svg)](https://gitter.im/ajv-validator/ajv)
 
 **Please note**
 
-ajv-errors v2-beta supports [ajv v7-beta](https://github.com/ajv-validator/ajv).
+ajv-errors v2 supports [ajv v7](https://github.com/ajv-validator/ajv).
 
 If you are using ajv v6, you should use [ajv-errors v1](https://github.com/ajv-validator/ajv-errors/tree/v1)
 
@@ -29,14 +28,6 @@ If you are using ajv v6, you should use [ajv-errors v1](https://github.com/ajv-v
 
 ## Install
 
-v2-beta:
-
-```
-npm install ajv-errors@beta
-```
-
-v1:
-
 ```
 npm install ajv-errors
 ```
@@ -294,12 +285,11 @@ const schema = {
 }
 ```
 
-#### Referring to Field Names
-
-Field names can be referred to by using the relative `0#` JSON-pointer. 
+#### Using property names in error messages
 
-Example which prints additional properties that cause validation error: 
+Property names can be used in error messages with the relative JSON-pointer (e.g. `0#`). 
 
+Example: 
 ```javascript
 const schema = {
   type: "object",
@@ -315,8 +305,6 @@ const schema = {
 }
 ```
 
-
-
 ## Options
 
 Defaults:

README.md

@@ -1,6 +1,6 @@
 {
   "name": "ajv-errors",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0",
   "description": "Custom error messages in JSON-Schema for Ajv validator",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,11 +11,11 @@
   "scripts": {
     "build": "rm -rf dist && tsc",
     "eslint": "eslint \"src/**/*.*s\" \"spec/**/*.*s\"",
-    "prettier:write": "prettier --write \"./**/*.{md,json,ts,js}\"",
-    "prettier:check": "prettier --list-different \"./**/*.{md,json,ts,js}\"",
+    "prettier:write": "prettier --write \"./**/*.{json,ts,js}\"",
+    "prettier:check": "prettier --list-different \"./**/*.{json,ts,js}\"",
     "test-spec": "jest \"spec/*.ts\"",
     "test-cov": "jest \"spec/*.ts\" --coverage",
-    "test": "npm run eslint && npm run build && npm run test-cov",
+    "test": "npm run prettier:check && npm run eslint && npm run build && npm run test-cov",
     "prepublish": "npm run build"
   },
   "repository": {
@@ -36,21 +36,20 @@
   },
   "homepage": "https://github.com/epoberezkin/ajv-errors#readme",
   "peerDependencies": {
-    "ajv": "^7.0.0-beta.7"
+    "ajv": "^7.0.0"
   },
   "devDependencies": {
     "@ajv-validator/config": "^0.3.0",
     "@types/jest": "^26.0.15",
     "@types/node": "^14.14.7",
     "@typescript-eslint/eslint-plugin": "^4.7.0",
     "@typescript-eslint/parser": "^4.7.0",
-    "ajv": "^7.0.0-beta.7",
+    "ajv": "^7.0.0",
     "eslint": "^7.2.0",
-    "eslint-config-prettier": "^6.15.0",
-    "husky": "^4.3.0",
+    "eslint-config-prettier": "^7.0.0",
+    "husky": "^5.1.3",
     "jest": "^26.6.3",
     "lint-staged": "^10.5.1",
-    "pre-commit": "^1.2.2",
     "prettier": "^2.1.2",
     "ts-jest": "^26.4.4",
     "typescript": "^4.0.5"
@@ -62,6 +61,6 @@
     }
   },
   "lint-staged": {
-    "*.{md,json,yaml,js,ts}": "prettier --write"
+    "*.{json,yaml,js,ts}": "prettier --write"
   }
 }

package.json

@@ -1,15 +1,17 @@
 import ajvErrors from ".."
 import Ajv, {SchemaObject, ErrorObject, ValidateFunction} from "ajv"
+import AjvPack from "ajv/dist/standalone/instance"
 import assert = require("assert")
 
+function _ajv(verbose?: boolean): Ajv {
+  return ajvErrors(new Ajv({allErrors: true, verbose, code: {source: true}}))
+}
+
 describe("errorMessage value is an object", () => {
-  let ajvs: Ajv[]
+  let ajvs: (Ajv | AjvPack)[]
 
   beforeEach(() => {
-    ajvs = [
-      ajvErrors(new Ajv({allErrors: true})),
-      ajvErrors(new Ajv({allErrors: true, verbose: true})),
-    ]
+    ajvs = [_ajv(), _ajv(true), new AjvPack(_ajv()), new AjvPack(_ajv(true))]
   })
 
   describe("keywords", () => {
@@ -50,7 +52,10 @@ describe("errorMessage value is an object", () => {
               assert.strictEqual(err.dataPath, "")
               assert.strictEqual(err.schemaPath, "#/errorMessage")
               const replacedKeywords = err.params.errors.map((e: ErrorObject) => e.keyword)
-              assert.deepStrictEqual(replacedKeywords.sort(), expectedErr.sort())
+              assert.deepStrictEqual(
+                Array.from(replacedKeywords.sort()),
+                Array.from(expectedErr.sort())
+              )
             } else {
               // original error
               assert.strictEqual(err.keyword, expectedErr)
@@ -134,7 +139,10 @@ describe("errorMessage value is an object", () => {
             assert.strictEqual(err.dataPath, "/foo")
             assert.strictEqual(err.schemaPath, "#/properties/foo/errorMessage")
             const replacedKeywords = err.params.errors.map((e: ErrorObject) => e.keyword)
-            assert.deepStrictEqual(replacedKeywords.sort(), expectedErr.sort())
+            assert.deepStrictEqual(
+              Array.from(replacedKeywords.sort()),
+              Array.from(expectedErr.sort())
+            )
           } else {
             // original error
             assert.strictEqual(err.keyword, expectedErr)
@@ -281,7 +289,10 @@ describe("errorMessage value is an object", () => {
             assert.strictEqual(err.dataPath, "")
             assert.strictEqual(err.schemaPath, "#/errorMessage")
             const replacedKeywords = err.params.errors.map((e: ErrorObject) => e.keyword)
-            assert.deepStrictEqual(replacedKeywords, Object.keys(expectedErr))
+            assert.deepStrictEqual(
+              Array.from(replacedKeywords),
+              Array.from(Object.keys(expectedErr))
+            )
           } else {
             // original error
             assert.strictEqual(err.keyword, expectedErr)
@@ -570,7 +581,10 @@ describe("errorMessage value is an object", () => {
           assert((Array.isArray(data) ? /^\/(0|1)$/ : /^\/(foo|bar)$/).test(err.dataPath))
           assert.strictEqual(err.schemaPath, "#/errorMessage")
           const replacedKeywords = err.params.errors.map((e: ErrorObject) => e.keyword)
-          assert.deepStrictEqual(replacedKeywords.sort(), expectedErr.sort())
+          assert.deepStrictEqual(
+            Array.from(replacedKeywords.sort()),
+            Array.from(expectedErr.sort())
+          )
         } else {
           // original error
           assert.strictEqual(err.keyword, expectedErr)
@@ -620,7 +634,10 @@ describe("errorMessage value is an object", () => {
                 : schema.errorMessage[expectedErr[0] === "required" ? "required" : "_"]
               assert.strictEqual(err.message, expectedMessage)
               const replacedKeywords = err.params.errors.map((e: ErrorObject) => e.keyword)
-              assert.deepStrictEqual(replacedKeywords.sort(), expectedErr.sort())
+              assert.deepStrictEqual(
+                Array.from(replacedKeywords.sort()),
+                Array.from(expectedErr.sort())
+              )
             } else {
               // original error
               assert.strictEqual(err.keyword, expectedErr)

spec/object.spec.ts

@@ -1,13 +1,15 @@
 import ajvErrors from ".."
 import Ajv, {ErrorObject} from "ajv"
+import AjvPack from "ajv/dist/standalone/instance"
 import assert = require("assert")
 
+function _ajv(verbose?: boolean): Ajv {
+  return ajvErrors(new Ajv({allErrors: true, verbose, code: {source: true}}))
+}
+
 describe("errorMessage value is a string", () => {
   it("should replace all errors with custom error message", () => {
-    const ajvs = [
-      ajvErrors(new Ajv({allErrors: true})),
-      ajvErrors(new Ajv({allErrors: true, verbose: true})),
-    ]
+    const ajvs = [_ajv(), _ajv(true), new AjvPack(_ajv()), new AjvPack(_ajv(true))]
 
     const schema = {
       type: "object",
@@ -40,7 +42,10 @@ describe("errorMessage value is a string", () => {
         const replacedKeywords = err.params.errors.map((e: ErrorObject) => {
           return e.keyword
         })
-        assert.deepStrictEqual(replacedKeywords.sort(), expectedReplacedKeywords.sort())
+        assert.deepStrictEqual(
+          Array.from(replacedKeywords.sort()),
+          Array.from(expectedReplacedKeywords.sort())
+        )
       }
     })
   })

spec/string.spec.ts

@@ -30,6 +30,7 @@ const used: Name = new Name("emUsed")
 const KEYWORD_PROPERTY_PARAMS = {
   required: "missingProperty",
   dependencies: "property",
+  dependentRequired: "property",
 }
 
 export interface ErrorMessageOptions {
@@ -291,7 +292,10 @@ function errorMessage(options: ErrorMessageOptions): CodeKeywordDefinition {
             _`${err}.dataPath.indexOf(${dataPath}) === 0`
           ),
           () => {
-            const childRegex = gen.scopeValue("pattern", {ref: /^\/([^/]*)(?:\/|$)/})
+            const childRegex = gen.scopeValue("pattern", {
+              ref: /^\/([^/]*)(?:\/|$)/,
+              code: _`new RegExp("^\\\/([^/]*)(?:\\\/|$)")`,
+            })
             const matches = gen.const(
               "emMatches",
               _`${childRegex}.exec(${err}.dataPath.slice(${dataPath}.length))`