diff --git a/.dictionary b/.dictionary index bef79fc..3a26823 100644 --- a/.dictionary +++ b/.dictionary @@ -11,3 +11,15 @@ JSON reviewable changeset non-tty +RoleVars +GroupVars +subdirectories +HostVars +Rolesfile +Makefile +Jinja2 +ANSIBLE([0-9]{4}) +LINT([0-9]{4}) +SCM +bools +Check[A-Z].+ diff --git a/docs/content/build_rules/candidates.md b/docs/content/build_rules/candidates.md index d32c8de..1b72896 100644 --- a/docs/content/build_rules/candidates.md +++ b/docs/content/build_rules/candidates.md @@ -4,19 +4,19 @@ title: Candidated Each file passed to `ansible-later` will be classified. The result is a `Candidate` object which contains some meta information and is an instance of one of following object types. -| Object type | Description | -| ----------- | ---------------------------------------------------------------------------------------------------------------------------- | -| Task | all files within the parent dir `tasks` | -| Handler | all files within the parent dir `handler` | -| RoleVars | all files within the parent dir `vars` or `default` | -| GroupVars | all files (including subdirs) within the parent dir `group_vars` | -| HostVars | all files (including subdirs) within the parent dir `host_vars` | -| Meta | all files within the parent dir `meta` | -| Code | all files within the parent dir `library`, `lookup_plugins`, `callback_plugins` and `filter_plugins` or python files (`.py`) | -| Inventory | all files within the parent dir `inventories` and `inventory` or `hosts` as filename | -| Rolesfile | all files with `rolesfile` or `requirements` in filename | -| Makefile | all files with `Makefile` in filename | -| Template | all files (including subdirs) within the parent dir `templates` or jinja2 files (`.j2`) | -| File | all files (including subdirs) within the parent dir `files` | -| Playbook | all yaml files (`.yml` or `.yaml`) not maching a previous object type | -| Doc | all files with `README` in filename | +| Object type | Description | +| ----------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| Task | all files within the parent directory `tasks` | +| Handler | all files within the parent directory `handler` | +| RoleVars | all files within the parent directory `vars` or `default` | +| GroupVars | all files (including subdirectories) within the parent directory `group_vars` | +| HostVars | all files (including subdirectories) within the parent directory `host_vars` | +| Meta | all files within the parent directory `meta` | +| Code | all files within the parent directory `library`, `lookup_plugins`, `callback_plugins` and `filter_plugins` or python files (`.py`) | +| Inventory | all files within the parent directory `inventories` and `inventory` or `hosts` as filename | +| Rolesfile | all files with `rolesfile` or `requirements` in filename | +| Makefile | all files with `Makefile` in filename | +| Template | all files (including subdirectories) within the parent directory `templates` or Jinja2 files (`.j2`) | +| File | all files (including subdirectories) within the parent directory `files` | +| Playbook | all YAML files (`.yml` or `.yaml`) not matching a previous object type | +| Doc | all files with `README` in filename | diff --git a/docs/content/included_rules/_index.md b/docs/content/included_rules/_index.md index b8433ef..1731686 100644 --- a/docs/content/included_rules/_index.md +++ b/docs/content/included_rules/_index.md @@ -8,18 +8,18 @@ Reviews are nothing without some rules or standards against which to review. ans | ----------------------------- | ----------- | ----------------------------------------------------------------- | -------------------------------------------------------------------- | | CheckYamlEmptyLines | LINT0001 | YAML should not contain unnecessarily empty lines. | {max: 1, max-start: 0, max-end: 1} | | CheckYamlIndent | LINT0002 | YAML should be correctly indented. | {spaces: 2, check-multi-line-strings: false, indent-sequences: true} | -| CheckYamlHyphens | LINT0003 | YAML should use consitent number of spaces after hyphens (-). | {max-spaces-after: 1} | +| CheckYamlHyphens | LINT0003 | YAML should use consistent number of spaces after hyphens (-). | {max-spaces-after: 1} | | CheckYamlDocumentStart | LINT0004 | YAML should contain document start marker. | {document-start: {present: true}} | -| CheckYamlColons | LINT0005 | YAML should use consitent number of spaces around colons. | {colons: {max-spaces-before: 0, max-spaces-after: 1}} | -| CheckYamlFile | LINT0006 | Roles file should be in yaml format. | | +| CheckYamlColons | LINT0005 | YAML should use consistent number of spaces around colons. | {colons: {max-spaces-before: 0, max-spaces-after: 1}} | +| CheckYamlFile | LINT0006 | Roles file should be in YAML format. | | | CheckYamlHasContent | LINT0007 | Files should contain useful content. | | | CheckNativeYaml | LINT0008 | Use YAML format for tasks and handlers rather than key=value. | | | CheckYamlDocumentEnd | LINT0009 | YAML should contain document end marker. | {document-end: {present: true}} | | CheckLineBetweenTasks | ANSIBLE0001 | Single tasks should be separated by an empty line. | | | CheckMetaMain | ANSIBLE0002 | Meta file should contain a basic subset of parameters. | author, description, min_ansible_version, platforms, dependencies | | CheckUniqueNamedTask | ANSIBLE0003 | Tasks and handlers must be uniquely named within a file. | | -| CheckBraces | ANSIBLE0004 | YAML should use consitent number of spaces around variables. | | -| CheckScmInSrc | ANSIBLE0005 | Use scm key rather than src: scm+url in requirements file. | | +| CheckBraces | ANSIBLE0004 | YAML should use consistent number of spaces around variables. | | +| CheckScmInSrc | ANSIBLE0005 | Use SCM key rather than `src: scm+url` in requirements file. | | | CheckNamedTask | ANSIBLE0006 | Tasks and handlers must be named. | excludes: meta, debug, include\_\*, import\_\*, block | | CheckNameFormat | ANSIBLE0007 | Name of tasks and handlers must be formatted. | formats: first letter capital | | CheckCommandInsteadofModule | ANSIBLE0008 | Commands should not be used in place of modules. | |