diff --git a/.gitignore b/.gitignore index 1993236..a0b56f1 100644 --- a/.gitignore +++ b/.gitignore @@ -61,3 +61,4 @@ node_modules # Generated ChangeLog AUTHORS +.rtox.cfg diff --git a/.gitreview b/.gitreview new file mode 100644 index 0000000..7071dfa --- /dev/null +++ b/.gitreview @@ -0,0 +1,4 @@ +[gerrit] +host=review.openstack.org +port=29418 +project=openstack/coats.git diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 0000000..71ad724 --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,15 @@ +--- +- job: + name: openstack-tox-linters-npm + parent: openstack-tox-linters + # bionic needed for less ancient nodejs/npm which would fail to install + # cspell regardless engines mentioned in package.json + nodeset: ubuntu-bionic + +- project: + check: + jobs: + - openstack-tox-linters-npm + gate: + jobs: + - openstack-tox-linters-npm diff --git a/README.md b/README.md index 8015b47..02ea0bb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # coats -[![Build Status](https://travis-ci.org/ssbarnea/coats.svg?branch=master)](https://travis-ci.org/ssbarnea/coats) - Collection of scripts (coats) that improve open-stack developer browsing experience FoxReplace.json is text replacements configuration for @@ -10,8 +8,12 @@ some extra coloring on build logs, making them easier to read. We plan to convert this into a greasemonkey helper in the future to allow use from multiple browsers. -![foxreplace-os-logs](https://s3.sbarnea.com/ss/181001-Mozilla_Firefox_.png) +![foxreplace-os-logs](https://raw.githubusercontent.com/openstack/coats/master/doc/source/_static/img/coats-log-highlight-example.png) After you install Firefox extension you can either do an one-time import -of the configuration from +of the configuration from or configure it to re-download it when it changes. + +## Contributing + +Before you raise a CR, please run "tox" to perform a sanity check. diff --git a/bindep.txt b/bindep.txt new file mode 100644 index 0000000..1c356ff --- /dev/null +++ b/bindep.txt @@ -0,0 +1,7 @@ +# This is a cross-platform list tracking distribution packages needed by tests; +# see http://docs.openstack.org/infra/bindep/ for additional information. + +nodejs [test] +nodejs-legacy [platform:ubuntu-xenial test] +nodejs-npm [platform:apk test] +npm [test] diff --git a/cspell.json b/cspell.json index 181c1fb..0a8696d 100644 --- a/cspell.json +++ b/cspell.json @@ -2,8 +2,6 @@ "version": "0.1", "language": "en", "words": [ - "Sbarnea", - "Sorin", "TOXENV", "atexit", "bdist", @@ -12,6 +10,7 @@ "envars", "envlist", "envs", + "gerrit", "htmlcov", "ifeq", "ifndef", @@ -24,6 +23,7 @@ "pytest", "repo", "repos", + "rtox", "sdist", "setenv", "symlink", @@ -52,7 +52,8 @@ "ignorePaths": [ "docs/build", ".tox", - ".eggs" + ".eggs", + "package-lock.json" ], "ignoreWords": [ "I18NSPHINXOPTS" diff --git a/doc/source/_static/img/coats-log-highlight-example.png b/doc/source/_static/img/coats-log-highlight-example.png new file mode 100644 index 0000000..d43eb6e Binary files /dev/null and b/doc/source/_static/img/coats-log-highlight-example.png differ diff --git a/package.json b/package.json index 6b56500..d209732 100644 --- a/package.json +++ b/package.json @@ -7,11 +7,14 @@ "test": "echo \"Error: no test specified\" && exit 1", "spell": "npm -s run spell-files && npm -s run spell-commit", "spell-commit": "git log -1 --pretty=%B > .git/commit.msg && cspell .git/commit.msg", - "spell-files": "git ls-files | xargs cspell --unique" + "spell-files": "git ls-files | xargs cspell --unique", + "//": "tox linter will also call npm spell-(commit) at the end", + "lint": "tox -e linters", + "prod": "gulp prod; python setup.py sdist" }, "repository": { "type": "git", - "url": "https://github.com/ssbarnea/coats.git" + "url": "https://github.com/openstack/coats.git" }, "keywords": [ "openstack", @@ -22,14 +25,13 @@ "zuul", "logs" ], - "author": "Sorin Sbarnea", + "author": "OpenStack", "license": "Apache-2.0", "bugs": { - "url": "https://github.com/ssbarnea/coats/issues" + "url": "https://storyboard.openstack.org/#!/project/openstack/coats" }, - "homepage": "https://github.com/ssbarnea/coats#readme", - "dependencies": { - "cspell": "^2.1.12", - "npm": "^6.1.0" + "homepage": "https://github.com/openstack/coats#readme", + "devDependencies": { + "cspell": "^2.1.12" } } diff --git a/setup.cfg b/setup.cfg index dbdf7ad..da6f1ac 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,13 +1,13 @@ [metadata] name = coats -author = Sorin Sbarnea -author-email = sorin.sbarnea@gmail.com -maintainer = Sorin Sbarnea -maintainer-email = sorin.sbarnea@gmail.com +author = OpenStack +author-email = openstack-dev@lists.openstack.org +maintainer = OpenStack +maintainer-email = openstack-dev@lists.openstack.org summary = Collection of scripts (coats) that improve open-stack developer browsing experience description-file = README.md -home-page = https://github.com/ssbarnea/coats +home-page = https://github.com/openstack/coats requires-python = >=2.7 license = BSD diff --git a/tox.ini b/tox.ini index 0831006..4ae7660 100644 --- a/tox.ini +++ b/tox.ini @@ -21,16 +21,21 @@ passenv = envars = PIP_DISABLE_PIP_VERSION_CHECK=1 PIP_USER=no + PATH={toxinidir}/node_modules/.bin:{env:PATH} whitelist_externals = bash echo find grep + node + npm rm + which xargs [testenv:linters] commands= pip install -q -r requirements.txt -r test-requirements.txt - bash -c "npm install && npm run spell" python -m pre_commit run --all + npm install -y + npm run spell