diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 9568ec85..e7ea7c1c 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,30 +1,35 @@ --- name: Bug Report about: Create a report to help us improve -title: \[BUG\] +title: \[BUG] labels: bug assignees: fmigneault - --- -**Describe the bug** +## Describe the bug + + + +## To Reproduce -**To Reproduce** Steps to reproduce the behavior: + 1. Deploy process with payload '...' 2. Execute using payload '....' 3. Result '....' 4. Error message '...' -**Expected behavior** +## Expected behavior + + -**Screenshots** -If applicable, add screenshots to help explain your problem. +## Environment -**Desktop (please complete the following information):** - - OS: \[e.g. Linux|Windows\] (if running locally) - - Browser \[e.g. chrome, safari\] (if running as a service) - - Instance: URL - - Version \["1.2.3", see `/version` endpoint\] +- OS: \[e.g. Linux|Windows] (if running locally) +- Browser \[e.g. chrome, safari] (if running as a service) +- Instance: URL +- Version \["1.2.3", see `/version` endpoint] diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 179274d9..bd0bef45 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -1,21 +1,31 @@ --- name: Feature Request about: Suggest an idea for this project -title: \[Feature\] +title: \[Feature] labels: feature assignees: fmigneault - --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. -Ex. I would like to be able to authenticate using \[...\] +## Describe the request + + + +## Expected behavior -**Describe the solution you'd like** -A clear and concise description of what you want to happen. + -**Describe alternatives you've considered** +## Alternatives considered + + + +## Additional context -**Additional context** + diff --git a/.gitignore b/.gitignore index e1c3cab4..9d2ae05d 100644 --- a/.gitignore +++ b/.gitignore @@ -12,7 +12,7 @@ share ## Node node_modules -package.json +!package.json package-lock.json ## Makefile diff --git a/.remarkignore b/.remarkignore new file mode 100644 index 00000000..1b6d93e1 --- /dev/null +++ b/.remarkignore @@ -0,0 +1,13 @@ +# To save time scanning +.idea/ +.vscode/ +*.egg-info/ +downloads/ +env/ + +# actual items to ignore +.pytest_cache/ +node_modules/ +docs/_build/ +docs/build/ +reports/ diff --git a/.stylelintrc.json b/.stylelintrc.json deleted file mode 100644 index cb464aab..00000000 --- a/.stylelintrc.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "extends": "stylelint-config-standard", - "ignoreFiles": ["docs/_build/**"], - "rules": { - "block-no-empty": null, - "color-no-invalid-hex": true, - "color-hex-case": "upper", - "color-hex-length": "long", - "indentation": [4], - "no-descending-specificity": null, - "property-no-vendor-prefix": null - } -} diff --git a/Makefile b/Makefile index 31c3d8f0..6cf97dee 100644 --- a/Makefile +++ b/Makefile @@ -341,18 +341,24 @@ install-dev: conda-env install-xargs ## install package requirements for develop # install locally to ensure they can be found by config extending them .PHONY: install-npm -install-npm: ## install npm package manager if it cannot be found +install-npm: ## install npm package manager and dependencies if they cannot be found @[ -f "$(shell which npm)" ] || ( \ echo "Binary package manager npm not found. Attempting to install it."; \ apt-get install npm \ ) - @[ `npm ls 2>/dev/null | grep stylelint-config-standard | wc -l` = 1 ] || ( \ - echo "Install required libraries for style checks." && \ + +.PHONY: install-npm-stylelint +install-npm-stylelint: install-npm ## install stylelint dependency for 'check-css' target using npm + @[ `npm ls 2>/dev/null | grep stylelint-config-standard | grep -v UNMET | wc -l` = 1 ] || ( \ + echo "Install required dependencies for CSS checks." && \ npm install --save-dev \ - stylelint \ - stylelint-scss \ - stylelint-config-standard \ - stylelint-csstree-validator \ + ) + +.PHONY: install-npm-remarklint +install-npm-remarklint: install-npm ## install remark-lint dependency for 'check-md' target using npm + @[ `npm ls 2>/dev/null | grep remark-lint | grep -v UNMET | wc -l` = 1 ] || ( \ + echo "Install required dependencies for Markdown checks." && \ + npm install --save-dev ) ## --- Launchers targets --- ## @@ -512,7 +518,7 @@ mkdir-reports: # autogen check variants with pre-install of dependencies using the '-only' target references CHECKS_EXCLUDE ?= CHECKS_PYTHON := pep8 lint security doc8 docf links imports types -CHECKS_NPM := css +CHECKS_NPM := css md CHECKS_PYTHON := $(filter-out $(CHECKS_EXCLUDE),$(CHECKS_PYTHON)) CHECKS_NPM := $(filter-out $(CHECKS_EXCLUDE),$(CHECKS_NPM)) CHECKS := $(CHECKS_PYTHON) $(CHECKS_NPM) @@ -606,15 +612,34 @@ check-types-only: mkdir-reports ## run typing validation .PHONY: check-css-only check-css-only: mkdir-reports @echo "Running CSS style checks..." - @npx stylelint \ - --config "$(APP_ROOT)/.stylelintrc.json" \ + @npx --no-install stylelint \ + --config "$(APP_ROOT)/package.json" \ --output-file "$(REPORTS_DIR)/fixed-css.txt" \ "$(APP_ROOT)/**/*.css" +.PHONY: check-css +check-css: install-npm-stylelint check-css-only ## check CSS linting after dependency installation + +# must pass 2 search paths because '