Skip to content

Commit f8fdb33

Browse files
authored
docs: clarify the requirement for naming of External Plugins (#503)
1 parent 5c73ac2 commit f8fdb33

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -149,21 +149,28 @@ In this case, apigeelint does not try to use `gcloud` to obtain an access token.
149149

150150

151151

152-
### Using External Plugins:
153-
```
154-
apigeelint -x ./externalPlugins -s path/to/your/apiproxy -f table.js
155-
```
156-
Where `-x` points to the directory containing externally developed plugins.
152+
### Using External Plugins
153+
154+
We package apigeelint with a broad set of plugins that we think
155+
will be generally valuable. For people that want to check for some
156+
case that is not covered by the bundled plugins, you can write your own plugin.
157+
Just follow the pattern as exhibited by the many plugins that are available.
158+
External Plugins must use a prefix of "EX".
157159

158160
You could, for example, create your own plugin for naming conventions, and
159161
exclude the builtin plugin that enforces naming conventions (`PO007`) with the
160162
`-e` option:
161163

164+
To use external plugins, specify the directory that contains them, on the
165+
command line. For example, this invocation might use your own plugin,
166+
and disable the built-in naming conventions that apigeelint checks:
167+
162168
```
163169
apigeelint -x ./externalPlugins -e PO007 -s path/to/your/apiproxy -f table.js
164170
```
165171

166-
This would effectively override the built-in naming conventions that apigeelint checks.
172+
In the above, `-x` points to the directory containing externally developed plugins.
173+
167174

168175

169176
### Excluding plugins
@@ -303,7 +310,6 @@ Example:
303310

304311
You can tell apigeelint to ignore these directives with the command-line otion `--ignoreDirectives`.
305312

306-
307313
## Pipeline lint job integration
308314

309315
### GitLab CI/CD

0 commit comments

Comments
 (0)