@@ -149,21 +149,28 @@ In this case, apigeelint does not try to use `gcloud` to obtain an access token.
149
149
150
150
151
151
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".
157
159
158
160
You could, for example, create your own plugin for naming conventions, and
159
161
exclude the builtin plugin that enforces naming conventions (` PO007 ` ) with the
160
162
` -e ` option:
161
163
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
+
162
168
```
163
169
apigeelint -x ./externalPlugins -e PO007 -s path/to/your/apiproxy -f table.js
164
170
```
165
171
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
+
167
174
168
175
169
176
### Excluding plugins
@@ -303,7 +310,6 @@ Example:
303
310
304
311
You can tell apigeelint to ignore these directives with the command-line otion ` --ignoreDirectives ` .
305
312
306
-
307
313
## Pipeline lint job integration
308
314
309
315
### GitLab CI/CD
0 commit comments