runem 0.0.9__py3-none-any.whl → 0.0.11__py3-none-any.whl

runem/runem.py

@@ -615,6 +615,7 @@ def _run_job(
 
     if not file_list:
         # no files to work on
+        print(f"WARNING: skipping job '{label}', no files for job")
         return (f"{label}: no files!", timedelta(0))
     if job_config["ctx"]["cwd"]:
         os.chdir(root_path / job_config["ctx"]["cwd"])

{runem-0.0.9.dist-info → runem-0.0.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runem
-Version: 0.0.9
+Version: 0.0.11
 Summary: Awesome runem created by lursight
 Home-page: https://github.com/lursight/runem/
 Author: lursight
@@ -47,6 +47,7 @@ The name "runem" is derived from the fusion of "run" and "them," encapsulating t
     - [4.1. Tag filters](#41-tag-filters)
       - [4.1.1. Run jobs only with the 'lint' tag:](#411-run-jobs-only-with-the-lint-tag)
       - [4.1.2. If you want to lint all code _except_ nodejs code (and you have the apprpriate tags):](#412-if-you-want-to-lint-all-code-except-nodejs-code-and-you-have-the-apprpriate-tags)
+      - [4.1.3. Run fast checks on `pre-commit`](#413-run-fast-checks-on-pre-commit)
     - [4.2. phase filters](#42-phase-filters)
       - [4.2.1 Focus on a phase](#421-focus-on-a-phase)
       - [4.2.2 Exclude slow phases temporarily](#422-exclude-slow-phases-temporarily)
@@ -86,14 +87,22 @@ $ python -m runem [--tags tag1,tag2,tag3] [--not-tags tag1,tag2,tag3] \
 ```
 
 ### 4.1. Tag filters
-You can control which types of jobs to run via tag. Just tag the job in the config and then from the command-line you can add `--tags` or `--not-tags` to refine exactly which jobs will be run. 
+Jobs are tagged in the .runem.yml config file. Each unique tags is made available on the command-line. To see which tags are available use `--help`. To add a new tag extend the `tags` field in the `job` config.
 
-To run only run jobs that have the `python` tag (for example, you define the tags) you would do the following:
+You can control which types of jobs to run via tags. Just tag the job in the config and then from the command-line you can add `--tags` or `--not-tags` to refine exactly which jobs will be run. 
+
+To debug why a job is not selected pass `--verbose`.
+
+For example, if you have a `python` tagged job or jobs, to run only run those jobs you would do the following:
 
 ```bash
 runem --tags python
 ```
 
+`--tags` are exclusive filter in, that is the tags passed in replace are the only tags that are run. This allows one to focus on running just a subset of tags.
+
+`--not-tags` are subtractive filter out, that is any job with these tags are not run, even if they have tags set via the `--tags` switch. Meaning you can choose to run `python` tagged jobed but not run the `lint` jobs with `--tags python --not-tags lint`, and so on.
+
 #### 4.1.1. Run jobs only with the 'lint' tag:
 
 ```bash
@@ -106,13 +115,26 @@ runem --tags lint
 runem --tags lint --not-tags deprecated
 ```
 
+#### 4.1.3. Run fast checks on `pre-commit`
+
+If you have fast jobs that tagged as appropriate for pre-commit hooks.
+
+```bash
+mkdir scripts/git-hooks
+echo "runem --tags pre-commit" > scripts/git-hooks/pre-commit
+# add the following to .git/config
+# [core]
+#   # ... existing config ...
+#	  hooksPath = ./scripts/git-hooks/husky/
+```
+
 ### 4.2. phase filters
 
-Sometimes you know you just want to run a specific phase to iterate quickly within that phase-context. 
+Sometimes just want to run a specific phase, so you can focus on it and iterate quickly, within that context. 
 
 #### 4.2.1 Focus on a phase
 
-For example you might want to run the 'reformat' phase as you're preparing a commit and are just made cosmetic changes e.g. updating the docs.
+For example, if you have a `reformat` phase, you might want to run just `reformat` jobs phase whilst preparing a commit and are just preparing cosmetic changes e.g. updating comments, syntax, or docs.
 
 ```bash
 runem --phase reformat
@@ -120,7 +142,7 @@ runem --phase reformat
 
 #### 4.2.2 Exclude slow phases temporarily
 
-Or you are tightly iterating on the 'test' phase coverage and do not care about formating as long as you can see your coverage results ASAP, but everything that comes after that stage. So if you have 4 stages `bootstrap`, `pre-run`, `reformat`, `test` and `verify` you can exlude the slower reformat-stage with the following and everything else will run
+If you have 4 stages `bootstrap`, `pre-run`, `reformat`, `test` and `verify` phase, and are tightly iterating and focusing on the 'test-coverage' aspect of the test-phase, then you do not care about formating as long as you can see your coverage results ASAP. However if your test-coverage starts passing then you will care about subsequent stages, so you can exlude the slower reformat-stage with the following and everything else will run.
 
 ```bash
 runem --not-phase pre-run reformat
@@ -147,8 +169,8 @@ usage: runem.py [-h] [--jobs JOBS [JOBS ...]] [--not-jobs JOBS_EXCLUDED [JOBS_EX
                 [--black] [--no-black] [--check-only] [--no-check-only] [--coverage] [--no-coverage] [--docformatter] [--no-docformatter]
                 [--generate-call-graphs] [--no-generate-call-graphs] [--install-deps] [--no-install-deps] [--isort] [--no-isort] [--profile]
                 [--no-profile] [--update-snapshots] [--no-update-snapshots] [--unit-test] [--no-unit-test] [--unit-test-firebase-data]
-                [--no-unit-test-firebase-data] [--unit-test-python] [--no-unit-test-python] [--call-graphs | --no-call-graphs] [--procs PROCS]
-                [--root ROOT_DIR] [--verbose | --no-verbose | -v]
+                [--no-unit-test-firebase-data] [--unit-test-python] [--no-unit-test-python] [--call-graphs | --no-call-graphs]
+                [--procs PROCS] [--root ROOT_DIR] [--verbose | --no-verbose | -v]
 
 Runs the Lursight Lang test-suite
 
@@ -162,27 +184,25 @@ options:
 
 jobs:
   --jobs JOBS [JOBS ...]
-                        List of job-names to run the given jobs. Other filters will modify this list. Defaults to '['cspell app', 'eslint app',
-                        'eslint fb_funcs', 'flake8 py', 'install python requirements', 'jest app', 'jest fb_funcs', 'json validate', 'mypy py',
-                        'pretty app', 'pretty fb_funcs', 'pylint py', 'reformat py', 'typescript app', 'typescript fb_funcs']'
+                        List of job-names to run the given jobs. Other filters will modify this list. Defaults to '['flake8 py', 'install
+                        python requirements', 'json validate', 'mypy py', 'pylint py', 'reformat py', 'spell check']'
   --not-jobs JOBS_EXCLUDED [JOBS_EXCLUDED ...]
-                        List of job-names to NOT run. Defaults to empty. Available options are: '['cspell app', 'eslint app', 'eslint fb_funcs',
-                        'flake8 py', 'install python requirements', 'jest app', 'jest fb_funcs', 'json validate', 'mypy py', 'pretty app',
-                        'pretty fb_funcs', 'pylint py', 'reformat py', 'typescript app', 'typescript fb_funcs']'
+                        List of job-names to NOT run. Defaults to empty. Available options are: '['flake8 py', 'install python requirements',
+                        'json validate', 'mypy py', 'pylint py', 'reformat py', 'spell check']'
 
 phases:
   --phases PHASES [PHASES ...]
-                        Run only the phases passed in, and can be used to change the phase order. Phases are run in the order given. Defaults to
-                        '{'analysis', 'edit', 'pre-run'}'.
+                        Run only the phases passed in, and can be used to change the phase order. Phases are run in the order given. Defaults
+                        to '{'edit', 'pre-run', 'analysis'}'.
   --not-phases PHASES_EXCLUDED [PHASES_EXCLUDED ...]
-                        List of phases to NOT run. This option does not change the phase run order. Options are '['analysis', 'edit', 'pre-run']'.
+                        List of phases to NOT run. This option does not change the phase run order. Options are '['analysis', 'edit', 'pre-
+                        run']'.
 
 tags:
   --tags TAGS [TAGS ...]
-                        Only jobs with the given tags. Defaults to '['app', 'data', 'json', 'lint', 'py', 'type']'.
+                        Only jobs with the given tags. Defaults to '['json', 'lint', 'py', 'spell', 'type']'.
   --not-tags TAGS_EXCLUDED [TAGS_EXCLUDED ...]
-                        Removes one or more tags from the list of job tags to be run. Options are '['app', 'data', 'json', 'lint', 'py',
-                        'type']'.
+                        Removes one or more tags from the list of job tags to be run. Options are '['json', 'lint', 'py', 'spell', 'type']'.
 
 job-param overrides:
   --black               allow/disallows py-black from running

runem-0.0.11.dist-info/RECORD

@@ -0,0 +1,14 @@
+runem/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+runem/__main__.py,sha256=dsOiVZegpfK9JOs5n7UmbX5iwwbj7iFkEbLoVeEgAn4,136
+runem/base.py,sha256=EZfR7FIlwEdU9Vfe47Wk2DOO8GQqpKxxLNKp6YHueZ4,316
+runem/cli.py,sha256=YFwon1P7uSpAYNuJxe2f0wo0HpI3OYTQ-UBWx6xU1iY,145
+runem/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+runem/run_command.py,sha256=SWFUxCwjkpeFjds9G7spR4Zu_DHDCAGHYPLaH5a5qWs,3671
+runem/runem.py,sha256=yTmL8fUMh70gLMAYDlFU-KV2lp8kZM9r3Huo8sCeu8E,34852
+scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+runem-0.0.11.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
+runem-0.0.11.dist-info/METADATA,sha256=r-hsbTKM7Swzuy2_hSCnT86htXew084ZNRmwnkU-7w4,15909
+runem-0.0.11.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+runem-0.0.11.dist-info/entry_points.txt,sha256=nu0g_vBeuPihYtimbtlNusxWovylMppvJ8UxdJlJfvM,46
+runem-0.0.11.dist-info/top_level.txt,sha256=rd8MZEjuPdjwXuLZlbdZEg8_WGxrY1c8M36uHjNjbNk,14
+runem-0.0.11.dist-info/RECORD,,

runem-0.0.9.dist-info/RECORD

@@ -1,14 +0,0 @@
-runem/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-runem/__main__.py,sha256=dsOiVZegpfK9JOs5n7UmbX5iwwbj7iFkEbLoVeEgAn4,136
-runem/base.py,sha256=EZfR7FIlwEdU9Vfe47Wk2DOO8GQqpKxxLNKp6YHueZ4,316
-runem/cli.py,sha256=YFwon1P7uSpAYNuJxe2f0wo0HpI3OYTQ-UBWx6xU1iY,145
-runem/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-runem/run_command.py,sha256=SWFUxCwjkpeFjds9G7spR4Zu_DHDCAGHYPLaH5a5qWs,3671
-runem/runem.py,sha256=wmpTzbaVHGpKvg6m3CSxArrQ2pn_EovnGv-dvHGbB2c,34784
-scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-runem-0.0.9.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
-runem-0.0.9.dist-info/METADATA,sha256=VsWMWKwkqJalZKHTsuSDkj5m8bxRS-_s49iAltD_jgs,14970
-runem-0.0.9.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-runem-0.0.9.dist-info/entry_points.txt,sha256=nu0g_vBeuPihYtimbtlNusxWovylMppvJ8UxdJlJfvM,46
-runem-0.0.9.dist-info/top_level.txt,sha256=rd8MZEjuPdjwXuLZlbdZEg8_WGxrY1c8M36uHjNjbNk,14
-runem-0.0.9.dist-info/RECORD,,