feat: add jest transformer support

README.md

@@ -12,16 +12,19 @@ Additionally Speccy [doesn't support JS modules](https://github.com/wework/specc
 which is a pain if you like writing your API documents like that - the underlying `oas-linter`
 has no problem though.
 
-Note that this module does not directly support YAML, but can by adding a wrapper
-file that parses your YAML and linting that instead, e.g. install [yaml](https://www.npmjs.com/package/yaml)
-and then create an `api.js` to lint, e.g.
+Note that this module does not directly support YAML, but can support them by adding
+a transformer to the jest config, e.g.
 
 ```javascript
-const fs = require('fs')
-const YAML = require('yaml')
-
-const file = fs.readFileSync('./file.yml', 'utf8')
-module.exports = YAML.parse(file)
+module.exports = {
+  runner: "oas-linter",
+  displayName: "oas-linter",
+  transform: {
+    "\\.yaml$": "jest-yaml-transform-not-flattened"
+  },
+  testMatch: ["<rootDir>/api/*.yaml"],
+  moduleFileExtensions: ["yaml"]
+};
 ```
 
 ## Warning
@@ -30,7 +33,7 @@ This is very alpha; no tests have been written, no promises made, YMMV.
 
 ## Compatibility
 
-This module is compatible with Node v8.x and upwards.  Any incompatibilities with those versions should be reported as bugs.
+This module is compatible with Node v8.x and upwards. Any incompatibilities with those versions should be reported as bugs.
 
 ## Usage
 
@@ -48,7 +51,7 @@ yarn add --dev jest jest-runner-oas-linter
 
 ### Add your runner to Jest config
 
-Once you have your Jest runner you can add it to your Jest config.  You will almost
+Once you have your Jest runner you can add it to your Jest config. You will almost
 certainly want to configure separate Jest [projects](https://jestjs.io/docs/en/configuration#projects-array-string-projectconfig)
 and only use this runner on modules that export an OpenAPI document.
 
@@ -75,14 +78,14 @@ In your `jest-oas-linter.config.js`
 
 ```js
 module.exports = {
-  runner: 'oas-linter',
-  displayName: 'oas-linter',
+  runner: "oas-linter",
+  displayName: "oas-linter",
   testMatch: [
-    '<rootDir>/path/to/your/api/doc.js',
-    '<rootDir>/path/to/another/api/doc.js',
-    '<rootDir>/path/to/another/api/doc/**/*.js',
-  ],
-}
+    "<rootDir>/path/to/your/api/doc.js",
+    "<rootDir>/path/to/another/api/doc.js",
+    "<rootDir>/path/to/another/api/doc/**/*.js"
+  ]
+};
 ```
 
 #### Minimal Steps
@@ -104,8 +107,8 @@ Or in `jest.config.js`
 
 ```js
 module.exports = {
-  runner: 'oas-linter',
-  testMatch: ['<rootDir>/path/to/your/api/doc.js'],
+  runner: "oas-linter",
+  testMatch: ["<rootDir>/path/to/your/api/doc.js"]
 };
 ```
 
@@ -115,8 +118,8 @@ Configuration can be specified in your project root in `.oaslintrc.json`, or in
 
 Currently the only two options are to specify whether the default rules should be loaded with `loadDefaultRules` and to specify additional rules to be applied.
 
-* `loadDefaultRules` is boolean and defaults to true, [oas-linter default rules](https://github.com/Mermade/oas-kit/blob/master/packages/oas-linter/rules.yaml) can be seen over there
-* `rules` is an array of objects, as per oas-linter's [applyRules](https://github.com/Mermade/oas-kit/blob/master/packages/oas-linter/index.js#L12).  More details about the format of rules supported can be found over at `oas-kit`'s [linter rules](https://mermade.github.io/oas-kit/linter-rules.html) documentation and the default rules (link above) have many examples.
+- `loadDefaultRules` is boolean and defaults to true, [oas-linter default rules](https://github.com/Mermade/oas-kit/blob/master/packages/oas-linter/rules.yaml) can be seen over there
+- `rules` is an array of objects, as per oas-linter's [applyRules](https://github.com/Mermade/oas-kit/blob/master/packages/oas-linter/index.js#L12). More details about the format of rules supported can be found over at `oas-kit`'s [linter rules](https://mermade.github.io/oas-kit/linter-rules.html) documentation and the default rules (link above) have many examples.
 
 In your `package.json`
 

package.json

@@ -33,6 +33,7 @@
   "dependencies": {
     "create-jest-runner": "^0.5.3",
     "jest": "^24.6.0",
+    "node-eval": "^2.0.0",
     "oas-linter": "^3.0.1",
     "oas-validator": "^3.3.0",
     "pkg-dir": "^4.2.0"

src/run.js

@@ -9,6 +9,7 @@ const {
 const validator = require('oas-validator')
 const linter = require('oas-linter')
 const pkgDir = require('pkg-dir')
+const nodeEval = require('node-eval')
 
 const DEFAULT_CONFIG = {
   loadDefaultRules: true,
@@ -17,13 +18,13 @@ const DEFAULT_CONFIG = {
 
 // Map an oas-linter warning to jest test result
 const warningToTest = (duration, testPath) => warning => {
-  const { ruleName, message, pointer } = warning
+  const { ruleName, pointer, rule } = warning
 
   return {
     duration,
-    errorMessage: message, // Does not seem to be used in reporters
+    errorMessage: `${rule.description} on ${pointer.replace(/~1/g, '/')}`, // Does not seem to be used in reporters
     testPath,
-    title: `${message} - ${pointer} (${ruleName})`
+    title: ruleName
   }
 }
 
@@ -73,10 +74,25 @@ const loadConfig = testPath =>
 
 // Run tests on a given file
 const run = ({ testPath, config, globalConfig }) => {
-  const schema = require(testPath)
+  const { transform } = config
+
+  let schema
+  let fileContent = fs.readFileSync(testPath, { encoding: 'utf-8' })
+
+  if (
+    !config.transformIgnorePatterns
+      .map(x => new RegExp(x))
+      .find(x => x.test(testPath))
+  ) {
+    const transformer = transform.find(x => new RegExp(x[0]).test(testPath))
+
+    if (transformer) {
+      const transformerObj = require(transformer[1])
+      fileContent = transformerObj.process(fileContent, testPath, config)
+    }
+  }
 
-  // Avoid caching for `--watch` mode
-  delete delete require.cache[require.resolve(testPath)]
+  schema = nodeEval(fileContent, testPath)
 
   const test = {
     path: testPath,
@@ -123,7 +139,7 @@ const run = ({ testPath, config, globalConfig }) => {
               return resolve(
                 fail({
                   ...result,
-                  errorMessage: 'Not a valid OpenAPI schema.'
+                  errorMessage: 'Not a valider OpenAPI schema: ' + error.message
                 })
               )
             }
@@ -133,6 +149,7 @@ const run = ({ testPath, config, globalConfig }) => {
               toTestResult({
                 errorMessage:
                   'Schema is valid, but linting errors were present.',
+                skipped: false,
                 stats: {
                   failures: warnings.length,
                   pending: 0,