Skip to content

Commit

Permalink
version reference bump
Browse files Browse the repository at this point in the history
  • Loading branch information
GantMan committed Feb 4, 2018
1 parent 18cad6b commit bae2311
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 8 deletions.
19 changes: 14 additions & 5 deletions .vscode/cSpell.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,46 @@
"language": "en",
// words - list of words to be always considered correct
"words": [
"async",
"ava",
"basic",
"callsite",
"checkmark",
"cli",
"clis",
"codecov",
"color",
"config",
"configs",
"custom",
"docsify",
"e.g.",
"env",
"envinfo",
"execa",
"filesystem",
"gitignore",
"gluegun",
"gluegun's",
"heartpulse",
"infinite.red",
"info",
"macos",
"newclear",
"npmignore",
"Plugin",
"Plugins",
"PRs",
"roadmap",
"rules",
"ruleset",
"shell",
"shipit",
"snapupdate",
"specs",
"tada",
"tempy",
"updtr",
"PRs",
"e.g.",
"async",
"color",
"v1"
],
// flagWords - list of words to be always considered incorrect
Expand All @@ -46,4 +55,4 @@
"Github",
"Cocoapods"
]
}
}
2 changes: 1 addition & 1 deletion docs/customRuleCheck.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Custom Rule Check

If you'd like to create your own rule, this can be done as of Solidarity v1.2+. This can be useful for any rule that cannot be easily constructed with the existing ruleset. Custom rules reside in you solidarity file among all other rules, and require the following:
If you'd like to create your own rule, this can be done as of Solidarity v2+. This can be useful for any rule that cannot be easily constructed with the existing ruleset. Custom rules reside in you solidarity file among all other rules, and require the following:

1. `rule` must be set to 'custom'
1. `plugin` prop is present and set to the name of your plugin, and defined in your `addPlugin` function config.
Expand Down
2 changes: 1 addition & 1 deletion docs/customRuleReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

As you know, when a user runs `solidarity report` as of Solidarity 1.1+, a GitHub friendly report is generated to the screen. You can provide this same functionality in your custom plugin by implementing a `report` function inside of your `rules` property.

> This is supported as of Solidarity v1.2+
> This is supported as of Solidarity v2+
You can add to any report table or create your own. The known report tables are:
* basicInfo - Reports the system and report results
Expand Down
2 changes: 1 addition & 1 deletion docs/customRuleSnapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

As you know, when a user runs `solidarity snapshot` and existing `.solidarity` file is in place, the versions of rules get updated to that environment. You can provide this same functionality in your custom plugin by implementing a `snapshot` function inside of your `rules` property.

> This is supported as of Solidarity v1.2+
> This is supported as of Solidarity v2+
We'll use the same rule (always pass) that was identified in the [custom rule check](/docs/customRuleCheck.md) section.

Expand Down

0 comments on commit bae2311

Please sign in to comment.