Release v0.8.0 (#106)

* deps; use oas-resolver

* Dropped validator tests now validator is gone

* Mention OAS Kit changes in changelog

* Config File (#102)

* Added config file (JSON or YAML)

* Renamed linter.initalize to linter.init

Shorter and consistent with how config turned out.

* Fixed linter tests

* Updated jekyll dependency yawn

* Updated dependencies

* Enabled path-keys-no-trailing-slash (#104)

* Fixed oas-linter changes for notEndWith

* Enabled path-keys-no-trailing-slash

* Published v0.8.0-dev3

* Changelog typo

* Removed common now oas-kit does all that

* Fixed verbose (quiet was also verbose!) (#111)

* Fix verbose in 0.8.0-devX

* Mention folder/file writing bug in changelog.

* Got rid of wework rules. Dont need em (#110)

* Release v0.8.0

Author: Phil Sturgeon

CHANGELOG.md

@@ -4,12 +4,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.8.0] - 2018-08-09
+### Changed
+- Switched to using [oas-kit] for resolving and validating
+- Moved `short-summary` from `wework` to `strict` rules ([#110])
+- YAML files were previously loaded in "JSON mode", which meant duplicate keys were allowed. They will now error ([#108])
+### Added
+- Config files can be passed with `-c` (defaults to `speccy.yaml`). See [README](./README.md) for more information
+- Enabled `path-keys-no-trailing-slash` now oas-resolver can handle keys for lint rules
+- Enabled [better-ajv-errors][] for beautiful validation errors. Linter errors remain unchanged
+### Fixed
+- Resolving to a file would silently fail when writing to a folder that did not exist
+### Removed
+- Got rid of `wework` rules, as the last rule was moved to `strict` ([#110])
+
 ## [0.7.3] - 2018-06-19
 ### Added
 - Provide "More Info" links in linter errors, so users understand the reasoning behind various rules. ([#78])
 
 
 [#90]: https://github.com/wework/speccy/pull/90
+[#108]: https://github.com/wework/speccy/pull/108
+[#110]: https://github.com/wework/speccy/pull/110
+[better-ajv-errors]: https://github.com/atlassian/better-ajv-errors
+[oas-kit]: https://github.com/Mermade/oas-kit
+
 
 ## [0.7.2] - 2018-05-31
 ### Fixed

README.md

@@ -23,16 +23,19 @@ If you want to run speccy on OpenAPI (f.k.a Swagger) v2.0 specs, run it through
 ```
 Usage: speccy <command>
 
+
 Options:
 
-  -V, --version  output the version number
-  -h, --help     output usage information
+-V, --version              output the version number
+-c, --config [configFile]  config file (containing JSON/YAML). See README for potential values.
+-h, --help                 output usage information
+
 
 Commands:
 
-  lint [options] <file-or-url>     ensure specs are not just valid OpenAPI, but lint against specified rules
-  resolve [options] <file-or-url>  pull in external $ref files to create one mega-file
-  serve [options] <file-or-url>    view specifications in beautiful human readable documentation
+lint [options] <file-or-url>     ensure specs are not just valid OpenAPI, but lint against specified rules
+resolve [options] <file-or-url>  pull in external $ref files to create one mega-file
+serve [options] <file-or-url>    view specifications in beautiful human readable documentation
 ```
 
 ### Lint Command
@@ -117,11 +120,41 @@ Options:
   -h, --help          output usage information
 ```
 
+### Config File
+
+To avoid needing to send command line options and switches every time, a config file can be used. Create
+a `speccy.yaml` in the root of your project.
+
+Example:
+```yaml
+# Convert JSON Schema-proper to OpenAPI-flavoured Schema Objects
+jsonSchema: true
+# Keep the noise down
+quiet: true
+# Output a lot of information about what is happening (wont work if you have quiet on)
+verbose: true
+# Rules specific to the lint command
+lint:
+  # rules files to load
+  rules:
+  - strict
+  - ./some/local/rules.json
+  - https://example.org/my-rules.json
+  # rules to skip
+  skip:
+  - info-contact
+# Rules specific to the resolve command
+resolve:
+  output: foo.yaml
+# Rules specific to the serve command
+serve:
+  port: 8001
+```
+
 ### Calling Speccy from Code
 
 Not just a command line tool, speccy can be used to normalize machine-readable specifications.
 
-
 The loader object will return a promise that resolves to an object containing
 the specification.  For example:
 

docs/Gemfile.lock

@@ -8,12 +8,6 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
-    autoprefixer-rails (8.6.3)
-      execjs
-    bootstrap (4.1.1)
-      autoprefixer-rails (>= 6.0.3)
-      popper_js (>= 1.12.9, < 2)
-      sass (>= 3.5.2)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
@@ -229,7 +223,6 @@ GEM
       sawyer (~> 0.8.0, >= 0.5.3)
     pathutil (0.16.1)
       forwardable-extended (~> 2.6)
-    popper_js (1.12.9)
     public_suffix (2.0.5)
     rack (1.6.10)
     rb-fsevent (0.10.3)
@@ -249,7 +242,7 @@ GEM
     sawyer (0.8.1)
       addressable (>= 2.3.5, < 2.6)
       faraday (~> 0.8, < 1.0)
-    sprockets (3.7.1)
+    sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     terminal-table (1.8.0)
@@ -265,7 +258,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bootstrap (~> 4.1)
   github-pages
   jekyll-assets
   jekyll-seo-tag

docs/index.md

@@ -57,8 +57,6 @@ There are going to be different things people are interested in, so the [default
 
 There are [strict rules][rules-strict] which demand more contact details, "real" domains, a license, and requires tags have a description!
 
-There are also [wework rules][rules-wework], building things we consider important on top of the strict rules; keeping summaries short (so they fit into ReDoc navigation for example).
-
 #### Rules
 
 Rule actions from the [default rules][rules-default] will be used if no rules file is specified. Right now there are only the three bundled options, but supporting custom rules files via local path and URL is on the roadmap.

lib/common.js

@@ -0,0 +1,68 @@
+'use strict';
+
+const nconf = require('nconf');
+
+nconf.formats.yaml = require('nconf-yaml');
+
+class Config {
+
+    init(args) {
+        const configFile = args.config || './speccy.yaml';
+
+        this.load(configFile, {
+            quiet: args.quiet,
+            jsonSchema: args.jsonSchema,
+            verbose: args.verbose,
+            // Command specific options
+            lint: {
+                rules: args.rules,
+                skip: args.skip,
+            },
+            resolve: {
+                output: args.output,
+            },
+            serve: {
+                port: args.port,
+            }
+        });
+    }
+
+    load(file, supplied) {
+        // 1, check the supplied values
+        nconf.add('supplied', {
+            type: 'literal',
+            store: this.cleanObject(supplied),
+        });
+
+        // 2, look in config file (e.g: speccy.yaml)
+        nconf.add('local', {
+            type: 'file',
+            format: nconf.formats.yaml,
+            file,
+        });
+    }
+
+    get(key, defaultValue) {
+        // Search through all known stores for the value
+        const value = nconf.get(key);
+        return (value === undefined) ? defaultValue : value;
+    }
+
+    // Don't want an object full of null
+    cleanObject(object) {
+        const cleaned = {};
+        Object.keys(object).forEach(key => {
+            const value = object[key];
+            if (value === undefined || value === null) {
+                return;
+            } else if (typeof value === "object") {
+                return cleaned[key] = this.cleanObject(value);
+            } else {
+                cleaned[key] = value;
+            }
+        });
+        return cleaned;
+    }
+}
+
+module.exports = new Config;

lib/config.js

@@ -21,7 +21,7 @@ const ensureRule = (context, rule, shouldAssertion) => {
 
 let activeRules = {};
 
-const initialize = () => {
+const init = () => {
     activeRules = {};
 };
 
@@ -47,7 +47,7 @@ const relevantRules = skipRules => {
     return rules.filter(rule => skipRules.indexOf(rule.name) === -1);
 }
 
-const lint = (objectName, object, options = {}) => {
+const lint = (objectName, object, key, options = {}) => {
     const { skip } = options;
 
     const rules = relevantRules(skip);
@@ -166,10 +166,16 @@ const lint = (objectName, object, options = {}) => {
                 }
             }
             if (rule.notEndWith) {
-                const { value, property } = rule.notEndWith;
-                ensure(rule, () => {
-                    should(object[property]).not.endWith(value);
-                });
+                const { omit, property, value } = rule.notEndWith;
+                let propertyValue = (property === '$key') ? key : object[property];
+                if (typeof propertyValue === 'string') {
+                    if (omit) {
+                        propertyValue = propertyValue.replace(omit,'');
+                    }
+                    ensure(rule, () => {
+                        propertyValue.should.not.endWith(value);
+                    });
+                }
             }
             if (rule.maxLength) {
                 const { value, property } = rule.maxLength;
@@ -193,6 +199,6 @@ const lint = (objectName, object, options = {}) => {
 module.exports = {
     createNewRule,
     createNewRules,
-    initialize,
+    init,
     lint,
 };