Add markdownlint to linting job

Author: dflook

.config/.markdownlint.yaml

@@ -0,0 +1,5 @@
+line-length:
+  line_length: 200
+  tables: false
+no-hard-tabs: false
+commands-show-output: false

.config/changelog.markdownlint.yaml

@@ -0,0 +1,11 @@
+line-length:
+  line_length: 300
+no-inline-html:
+  allowed_elements: ['p', 'img']
+ul-style:
+  style: sublist
+no-duplicate-heading:
+  siblings_only: true
+blanks-around-headings:
+  lines_below: 0
+blanks-around-lists: false

.github/workflows/test.yaml

@@ -101,3 +101,16 @@ jobs:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           uvx zizmor --format plain .
+
+      - name: Lint CHANGELOG
+        uses: DavidAnson/markdownlint-cli2-action@05f32210e84442804257b2a6f20b273450ec8265 # v19
+        with:
+          config: '.config/changelog.markdownlint.yaml'
+          globs: 'CHANGELOG.md'
+
+      - name: Lint Other Markdown
+        uses: DavidAnson/markdownlint-cli2-action@05f32210e84442804257b2a6f20b273450ec8265 # v19
+        with:
+          config: '.config/.markdownlint.yaml'
+          globs: |
+            **/README.md

CHANGELOG.md

@@ -36,14 +36,14 @@ the minified code may only run with Python 3.12.
 
 ### Added
 - Python 3.13 support, including:
-    - PEP 696 Type parameter defaults
+  + PEP 696 Type parameter defaults
 
 ## [2.10.0] - 2024-09-15
 
 ### Added
 - Python 3.12 support, including:
-    - PEP 695 Type parameter syntax
-    - PEP 701 Improved f-strings
+  + PEP 695 Type parameter syntax
+  + PEP 701 Improved f-strings
 
 - A new transform to remove the brackets when instantiating and raising built-in exceptions, which is enabled by default.
   e.g.
@@ -58,7 +58,7 @@ the minified code may only run with Python 3.12.
   ```python
   def a():raise ValueError
   ```
- 
+
   The raise statement automatically instantiates classes derived from Exception, so the brackets are not required.
 
 - A new constant folding transform, which is enabled by default.
@@ -69,16 +69,17 @@ the minified code may only run with Python 3.12.
   ```
 
   Will be minified to:
+
   ```python
   SECONDS_IN_A_DAY=86400
   ```
 
 ### Changed
 - Annotation removal is now more configurable, with separate options for:
-    - Removal of variable annotations (`--no-remove-variable-annotations`)
-    - Removal of function return annotations (`--no-remove-return-annotations`)
-    - Removal of function argument annotations (`--no-remove-argument-annotations`)
-    - Removal of class attribute annotations (`--remove-class-attribute-annotations`)
+  + Removal of variable annotations (`--no-remove-variable-annotations`)
+  + Removal of function return annotations (`--no-remove-return-annotations`)
+  + Removal of function argument annotations (`--no-remove-argument-annotations`)
+  + Removal of class attribute annotations (`--remove-class-attribute-annotations`)
 
   The default behavior has changed, with class attribute annotations no longer removed by default.
   These are increasingly being used at runtime, and removing them can cause issues.
@@ -117,10 +118,10 @@ the minified code may only run with Python 3.12.
   The debug specifier should now be preserved where it is used in the input source.
 
 - Many small improvements to minification to be more precise about where whitespace or parentheses required
-  - Thanks [luk3yx](https://github.com/luk3yx) for improving whitespace in relative import statements.
-  - A generator as the sole argument to a function call is no longer wrapped in parentheses
-  - float literals can use a more compact scientific notation
-  - Many more subtle improvements
+  + Thanks [luk3yx](https://github.com/luk3yx) for improving whitespace in relative import statements.
+  + A generator as the sole argument to a function call is no longer wrapped in parentheses
+  + float literals can use a more compact scientific notation
+  + Many more subtle improvements
 
 ## [2.8.1] - 2023-03-15
 
@@ -132,8 +133,8 @@ the minified code may only run with Python 3.12.
 
 ### Added
 - New transforms that together work similarly to Python's [-O option](https://docs.python.org/3/using/cmdline.html#cmdoption-O)
-    - Remove asserts, which removes assert statements and is disabled by default
-    - Remove debug, which removes any `if` block that tests `__debug__ is True` and is disabled by default
+  + Remove asserts, which removes assert statements and is disabled by default
+  + Remove debug, which removes any `if` block that tests `__debug__ is True` and is disabled by default
 
 ### Changed
 - When minifiying a directory, files ending with '.pyw' will now be minified.
@@ -144,7 +145,7 @@ the minified code may only run with Python 3.12.
 - Python 3.11 support, including exception groups syntax
 
 ### Changed
-- Improved detection of dataclasses when using the remove annotations transform, 
+- Improved detection of dataclasses when using the remove annotations transform,
   which suppresses removal of annotations for those classes
 
 ### Fixed
@@ -156,10 +157,10 @@ the minified code may only run with Python 3.12.
 ### Added
 - A new option to preserve the shebang line from the source file, which is enabled by default
 - More flexible file processing options for the `pyminify` command:
-    - A new `--output` argument for writing the minified output to a file without having to use shell redirection
-    - A new `--in-place` option which overwrites the specified path with the minified output
-    - `path` arguments may be directories, which minifies all *.py files below that directory
-    - Multiple `path` arguments may be specified, which will all be minified
+  + A new `--output` argument for writing the minified output to a file without having to use shell redirection
+  + A new `--in-place` option which overwrites the specified path with the minified output
+  + `path` arguments may be directories, which minifies all *.py files below that directory
+  + Multiple `path` arguments may be specified, which will all be minified
 - Type information is included in the package to enable type checking of the public functions
 
 ### Fixed
@@ -192,7 +193,7 @@ the minified code may only run with Python 3.12.
 
 ### Added
 - Support for Python 3.9, including:
-    - PEP 614 - Relaxing Grammar Restrictions On Decorators
+  + PEP 614 - Relaxing Grammar Restrictions On Decorators
 
 ## [2.3.2] - 2020-10-11
 
@@ -208,7 +209,7 @@ the minified code may only run with Python 3.12.
 
 ### Added
 - Optional source transform:
-    - convert positional arguments to normal arguments, enabled by default
+  + convert positional arguments to normal arguments, enabled by default
 
 ### Fixed
 - Unnecessary spaces after ',' in tuple values
@@ -222,11 +223,12 @@ the minified code may only run with Python 3.12.
 - Fixed PendingDeprecationWarnings
 
 ## [2.2.0] - 2019-10-27
+
 ### Added
 - Support for Python 3.8 language features:
-    - Assignment expressions
-    - Positional parameters
-    - f-string = specifier
+  + Assignment expressions
+  + Positional parameters
+  + f-string = specifier
 
 ### Changed
 - Removed unnecessary parenthesis around yield statements
@@ -235,27 +237,31 @@ the minified code may only run with Python 3.12.
 - Reading from stdin
 
 ## [2.1.2] - 2019-06-27
+
 ### Changed
 - Improved renaming performance
 
 ## [2.1.1] - 2019-04-07
+
 ### Changed
 - Removed redundant parentheses from comprehension iteration values
 
 ## [2.1.0] - 2019-01-24
+
 ### Added
 - Optional source transforms:
-    - remove object base, enabled by default
+  + remove object base, enabled by default
 
 ### Changed
 - Return statements no longer wrap tuples in extraneous parentheses
 - Duplicated literals are only raised to the lowest common function namespace
 
 ## [2.0.0] - 2019-01-13
+
 ### Added
 - Optional source transformations:
-    - Rename locals, enabled by default
-    - Rename globals, disabled by default
+  + Rename locals, enabled by default
+  + Rename globals, disabled by default
 
 ### Changed
 - Minified code will no longer have leading or trailing whitespace
@@ -268,15 +274,17 @@ the minified code may only run with Python 3.12.
 - Python 3.7 dataclass field annotations are no longer removed when the remove annotation transformation is enabled
 
 ## [1.1.0] - 2018-06-05
+
 ### Added
 - Optional source transformations:
-    - Combine import statements
-    - Remove annotations
-    - Remove pass statements
-    - Remove unused literals, including docstrings
-    - Move duplicated literals into module level variables
+  + Combine import statements
+  + Remove annotations
+  + Remove pass statements
+  + Remove unused literals, including docstrings
+  + Move duplicated literals into module level variables
 
 ## [1.0.0] - 2018-05-25
+
 ### Added
 - python-minifier package
 - pyminify command

README.md

@@ -93,7 +93,7 @@ def handler(event,context):
 
 ## Why?
 
-AWS Cloudformation templates may have AWS lambda function source code embedded in them, but only if the function is less 
+AWS Cloudformation templates may have AWS lambda function source code embedded in them, but only if the function is less
 than 4KiB. I wrote this package so I could write python normally and still embed the module in a template.
 
 ## Installation

src/python_minifier/rename/README.md

@@ -2,7 +2,7 @@
 
 We can save bytes by shortening the names used in a python program.
 
-One simple way to do this is to replace each unique name in a module with a shorter one. 
+One simple way to do this is to replace each unique name in a module with a shorter one.
 This will probably exhaust the available single character names, so is not as efficient as it could be.
 Also, not all names can be safely changed this way.
 
@@ -22,6 +22,7 @@ Namespaces in python are introduced by Modules, Functions, Comprehensions, Gener
 The AST node that introduces a new namespace is called a 'namespace node'.
 
 These attributes are added to namespace nodes:
+
 - Bindings - A list of Bindings local to this namespace, populated by the Bind names step
 - Globals - A list of global names in this namespace
 - Nonlocals - A list of nonlocal names in this namespace
@@ -50,6 +51,7 @@ The node is added to the NameBinding as a reference.
 If the name is nonlocal in its namespace it does not create a binding.
 
 Nodes that create a binding:
+
 - FunctionDef nodes bind their name
 - ClassDef nodes bind their name
 - arg nodes bind their arg
@@ -68,10 +70,10 @@ If a name is nonlocal in a searched namespace, skip to the next parent namespace
 When traversing parent namespaces, Class namespaces are skipped.
 
 If a NameBinding is found, add the node as a reference.
-If no NameBinding is found, check if the name would resolve to a builtin. 
+If no NameBinding is found, check if the name would resolve to a builtin.
 If so, create a BuiltinBinding in the module namespace and add this node as a reference.
 
-Otherwise we failed to find a binding for this name - Create a NameBinding in the module namespace and add this node 
+Otherwise we failed to find a binding for this name - Create a NameBinding in the module namespace and add this node
 as a reference.
 
 ## Hoist Literals
@@ -84,7 +86,8 @@ to introduce new names.
 Collect all bindings in the module and sort by estimated byte savings
 
 For each binding:
- - Determine it's 'reservation scope', which is the set of namespaces that name is referenced in (and all namespaces between them)
- - Get the next available name that is unassigned and unreserved in all namespaces in the reservation scope.
- - Check if we should proceed with the rename - is it space efficient to do this rename, or has the original name been assigned somewhere else?
- - Rename the binding, rename all referenced nodes to the new name, and record this name as assigned in every namespace of the reservation scope.
+
+- Determine it's 'reservation scope', which is the set of namespaces that name is referenced in (and all namespaces between them)
+- Get the next available name that is unassigned and unreserved in all namespaces in the reservation scope.
+- Check if we should proceed with the rename - is it space efficient to do this rename, or has the original name been assigned somewhere else?
+- Rename the binding, rename all referenced nodes to the new name, and record this name as assigned in every namespace of the reservation scope.