Skip to content

space-sh/spacechecker

Repository files navigation

Spacechecker: module analysis | build status

Performs analysis of other modules, looking for a set of properties and testing for conformance with Space guidelines.

/run/

Run module analysis

Takes a module directory path as input and perform analysis check on its contents.
Example: space -m spacechecker /run/ -- .

Functions

SPACECHECKER_DEP_INSTALL()

Check dependencies for this module.

_CHECK_DEP_INSTALL_NODE()

Check if module has dep_install node implemented.

_CHECK_LICENSE_FILE_EXISTS()

Check if module has LICENSE file present.

_CHECK_CHANGELOG_FILE_EXISTS()

Check if module has CHANGELOG file present.

_CHECK_README_FILE_EXISTS()

Check if module has README file present.

_CHECK_UPDATE_README_FILE_EXISTS()

Check if module has update_readme script present.

_CHECK_STABLE_FILE_EXISTS()

Check if module has stable file present.

_CHECK_REQUIREMENT_FILE_EXISTS()

Check if module has requirement file present.

_CHECK_TESTS_EXIST()

Check if module has tests structure in place.

_CHECK_DOC_EXIST()

Check if module has doc structure in place.

_CHECK_GITLABCI_FILE_EXISTS()

Check if module has gitlab-ci file present.

_CHECK_BASHISMS()

Check if module possibly has bashisms

_CHECK_MODULE()

Check if module complies with Space module guidelines.

Parameters:

  • $1: module directory path

Returns:

  • 0: success
  • 1: failed. Directory path is not pointing to a module.

About

Space.sh module for performing conformance tests

Resources

License

Stars

Watchers

Forks

Contributors

Languages