init alpha version (#2)

DariuszPorowski · web-flow · commit e9fd9ee44303 · 2023-02-03T22:56:30.000-08:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,19 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = tab
+
+[*.{cmd,bat}]
+end_of_line = crlf
+
+[*.{yml,yaml,md}]
+indent_style = space
+indent_size = 2
+
+[*.py]
+indent_style = space
+indent_size = 4
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,20 @@
+###############################
+# Git Line Endings            #
+###############################
+
+# Set default behaviour to automatically normalize line endings.
+* text=auto eol=lf
+
+# Force batch scripts to always use CRLF line endings so that if a repo is accessed
+# in Windows via a file share from Linux, the scripts will work.
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf
+
+# Force bash scripts to always use LF line endings so that if a repo is accessed
+# in Unix via a file share from Windows, the scripts will work.
+*.sh text eol=lf
+
+# Common files config
+*.jpg -text
+*.png -text
+*.pdf -text
diff --git a/.github/workflows/workflow.pr.yml b/.github/workflows/workflow.pr.yml
@@ -18,24 +18,23 @@ jobs:
       - name: Checkout Repo
         uses: actions/checkout@v3
 
+      - name: Install Poetry
+        run: pipx install poetry
+
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
           python-version: "3.10"
           cache: "poetry"
 
-      - name: Setup Poetry
-        run: |
-          pip install poetry
-          poetry --version
-
       - name: Install dependencies
-        run: poetry install
+        run: poetry install --only=dev
 
       - name: Check formatting
         run: poetry run black --check .
 
   test:
+    name: Test
     needs: lint
     strategy:
       fail-fast: false
@@ -47,17 +46,15 @@ jobs:
       - name: Checkout Repo
         uses: actions/checkout@v3
 
+      - name: Install Poetry
+        run: pipx install poetry
+
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
           cache: "poetry"
 
-      - name: Setup Poetry
-        run: |
-          pip install poetry
-          poetry --version
-
       - name: Install dependencies
         run: poetry install
 
diff --git a/.github/workflows/workflow.release.draft.yml b/.github/workflows/workflow.release.draft.yml
@@ -20,8 +20,6 @@ jobs:
       - name: Release Drafter
         uses: release-drafter/release-drafter@v5
         id: release-drafter
-        with:
-          prerelease: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
diff --git a/.github/workflows/workflow.release.yml b/.github/workflows/workflow.release.yml
@@ -0,0 +1,41 @@
+---
+name: Release
+
+on:
+  release:
+    types:
+      - prereleased
+      - released
+      - published
+
+jobs:
+  release:
+    if: ${{ !github.event.release.prerelease && github.event.action == 'released' && github.repository_owner == 'DariuszPorowski' }}
+    environment:
+      name: PyPI
+      url: "https://pypi.org/project/mkdocs-file-filter-plugin"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+
+      - name: Install Poetry
+        run: pipx install poetry
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: "poetry"
+
+      - name: Install dependencies
+        run: poetry install
+
+      - name: Set Version
+        run: poetry version ${GITHUB_REF_NAME/v/}
+
+      - name: Build
+        run: poetry build
+
+      - name: Publish
+        run: poetry publish --username=__token__ --password ${{ secrets.PYPI_API_TOKEN }}
diff --git a/.mkdocsignore b/.mkdocsignore
@@ -0,0 +1,3 @@
+# MkDocs
+docs/test/**
+docs/**/draft-*.md
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,20 @@
+{
+	"yaml.schemas": {
+		"https://squidfunk.github.io/mkdocs-material/schema.json": [
+			"mkdocs.yml"
+		]
+	},
+	"files.trimTrailingWhitespace": true,
+	"git.autofetch": true,
+	"git.fetchOnPull": true,
+	"git.pruneOnFetch": true,
+	"git.branchProtection": [
+		"main",
+		"master"
+	],
+	"files.associations": {
+		"*.mkdocsignore": "ignore",
+		".pages": "yaml"
+	},
+	"python.linting.enabled": true
+}
diff --git a/README.md b/README.md
@@ -1,2 +1,115 @@
-# mkdocs-filesfilter
-A mkdocs plugin that lets you exclude/include files or trees from your output.
+# File exclude/include plugin for MkDocs
+
+[![PyPI - Version](https://img.shields.io/pypi/v/mkdocs-file-filter-plugin.svg)](https://pypi.org/project/mkdocs-file-filter-plugin)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-file-filter-plugin.svg)](https://pypi.org/project/mkdocs-file-filter-plugin)
+
+---
+
+`mkdocs-file-filter` is a [mkdocs plugin](http://www.mkdocs.org/user-guide/plugins/) that allows you to exclude/include files from your input using Unix-style wildcards (globs), regular expressions (regexes) or .mkdocsignore file ([gitignore-style](https://git-scm.com/docs/gitignore) syntax).
+
+## Quick start
+
+1. Install the plugin using pip.
+
+```console
+pip install mkdocs-file-filter-plugin
+```
+
+1. In your project, add a plugin configuration to `mkdocs.yml`:
+
+  ```yaml
+  plugins:
+    - file-filter:
+        mkdocsignore: true
+        mkdocsignore_file: 'custom/path/.mkdocsignore' # relative to mkdocs.yml
+        exclude_glob:
+          - 'exclude/this/path/*'
+          - 'exclude/this/file/draft.md'
+          - '*.tmp'
+          - '*.gz'
+        exclude_regex:
+          - '.*\.(tmp|bin|tar)$'
+        include_glob:
+          - 'include/this/path/*'
+          - 'include/this/file/Code-of-Conduct.md'
+          - '*.png'
+          - 'assets/**' # the material theme requires this folder
+        include_regex:
+          - '.*\.(js|css)$'
+  ```
+
+## External config file
+
+The plugin supports external files for the plugin configuration. If the external config file is specified, then `*_glob:` and `*_regex:` are not taken `mkdocs.yml` - only config from the external file applies.
+
+```yaml
+plugins:
+  - file-filter:
+      # config: !ENV [MY_FILE_FILTER_CONFIG, 'mkdocs.file-filter.yml']
+      config: mkdocs.file-filter.yml
+```
+
+External plugin config file example.
+
+```yaml
+mkdocsignore: false
+exclude_glob:
+  - 'exclude/this/path/*'
+  - 'exclude/this/file/draft.md'
+  - '*.tmp'
+  - '*.gz'
+exclude_regex:
+  - '.*\.(tmp|bin|tar)$'
+include_glob:
+  - 'include/this/path/*'
+  - 'include/this/file/Code-of-Conduct.md'
+  - '*.png'
+  - 'assets/**' # the material theme requires this folder
+include_regex:
+  - '.*\.(js|css)$'
+```
+
+> **HINT**
+>
+> For external file config, you can use [MkDocs Environment Variables](https://www.mkdocs.org/user-guide/configuration/#environment-variables) to set the desired file dynamically. A useful case for serving the site with different content based on stage/environment. Works well with CI/CD automation.
+
+## .mkdocsignore
+
+Setting `mkdocsignore` to `true` will exclude the dirs/files specified in the `.mkdocsignore`. Use the same syntax as you use for gitignore.
+
+Optionally you can set `mkdocsignore_file` parameter with your path to `.mkdocsignore` file. By default, the plugin uses `.mkdocsignore` from the root of your MkDocs.
+
+You can combine mkdocsignore with globs/regex as well. The patterns from both will apply.
+
+External config for mkdocsignore.
+
+```yaml
+plugins:
+  - file-filter:
+      mkdocsignore: true # default: false
+      mkdocsignore_file: 'custom/path/.myignore' # relative to mkdocs.yml, default: .mkdocsignore
+```
+
+Example `.mkdocsignore` file.
+
+```bash
+# MkDocs
+docs/test/**
+docs/**/draft-*.md
+```
+
+## Conflict behavior
+
+It is possible to exclude and include will have conflict. For example, you could exclude `drafts/*` but include `*.md`. In that case, **include** has higher priority over exclude. So all `*.md` files from the drafts folder will be included.
+
+## Some useful stuff
+
+If you do not provide patterns, everything will stay the same - standard MkDocs behavior.
+
+Because of the YAML syntax specifics, patterns that start with a punctuation mark must be quoted.
+
+The preferred way for quotes is to use single quotes `'` rather than double quotes `"` - regex backslash escapes are preserved correctly without being doubled up.
+
+## License
+
+`mkdocs-file-filter-plugin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
diff --git a/dev.build.sh b/dev.build.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+rm -rf dist && rm -rf build
+poetry run black .
+poetry build
+pip uninstall -y mkdocs_file_filter_plugin
+pip install dist/mkdocs_file_filter_plugin-*.tar.gz
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,12 @@
+---
+tags:
+  - Secrets Store
+  - Secrets Storage
+  - Keys Store
+  - Keys Storage
+  - Security
+---
+
+# file-filter
+
+test
diff --git a/docs/aaa/README.md b/docs/aaa/README.md
@@ -0,0 +1,7 @@
+---
+tags:
+  - tag1
+  - tag2
+---
+
+# README
diff --git a/docs/aaa/bbb/draft-bbb.md b/docs/aaa/bbb/draft-bbb.md
@@ -0,0 +1 @@
+# draft-bbb
diff --git a/docs/aaa/draft-aaa.md b/docs/aaa/draft-aaa.md
@@ -0,0 +1 @@
+# draft-aaa
diff --git a/docs/draft-docs.md b/docs/draft-docs.md
@@ -0,0 +1 @@
+# draft-docs
diff --git a/docs/test/abc.md b/docs/test/abc.md
@@ -0,0 +1 @@
+# abc
diff --git a/docs/test/test.md b/docs/test/test.md
@@ -0,0 +1 @@
+# test
diff --git a/docs/test/xyz.md b/docs/test/xyz.md
@@ -0,0 +1 @@
+# xyz
diff --git a/mkdocs.base.yml b/mkdocs.base.yml
@@ -0,0 +1,4 @@
+site_name: Test Site
+
+plugins:
+  - file-filter:
diff --git a/mkdocs.file-filter.yml b/mkdocs.file-filter.yml
@@ -0,0 +1,3 @@
+mkdocsignore: true
+include_glob:
+  - 'test/test.md'
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,5 @@
+INHERIT: mkdocs.base.yml
+
+plugins:
+  - file-filter:
+      config: !ENV [MY_FILE_FILTER_CONFIG, "mkdocs.file-filter.yml"]
diff --git a/mkdocs_file_filter_plugin/__init__.py b/mkdocs_file_filter_plugin/__init__.py
@@ -0,0 +1 @@
+from .plugin import FileFilter
diff --git a/mkdocs_file_filter_plugin/judger.py b/mkdocs_file_filter_plugin/judger.py
@@ -0,0 +1,47 @@
+import os
+import fnmatch
+import re
+import pathlib
+import igittigitt
+
+
+class Judger:
+    def __init__(self, config):
+        self.config = config
+
+        if self.config.mkdocsignore:
+            self.mkdocsignore_parser = igittigitt.IgnoreParser()
+            self.mkdocsignore_parser.parse_rule_file(
+                pathlib.Path(self.config.mkdocsignore_file)
+            )
+
+    def evaluate(self, src_path, abs_src_path):
+        if os.sep is not "/":
+            src_path = src_path.replace(os.sep, "/")
+            abs_src_path = abs_src_path.replace(os.sep, "/")
+
+        if not self.__included(src_path, abs_src_path):
+            return False
+
+        return True
+
+    def __included(self, src_path, abs_src_path):
+        for glob in self.config.include_glob:
+            if fnmatch.fnmatchcase(src_path, glob):
+                return True
+        for regex in self.config.include_regex:
+            if re.match(regex, src_path):
+                return True
+        for glob in self.config.exclude_glob:
+            if fnmatch.fnmatchcase(src_path, glob):
+                return False
+        for regex in self.config.exclude_regex:
+            if re.match(regex, src_path):
+                return False
+        if self.config.mkdocsignore and self.__mkdocsignore(abs_src_path):
+            return False
+
+        return True
+
+    def __mkdocsignore(self, abs_src_path):
+        return self.mkdocsignore_parser.match(pathlib.Path(abs_src_path))
diff --git a/mkdocs_file_filter_plugin/plugin.py b/mkdocs_file_filter_plugin/plugin.py
diff --git a/mkdocs_file_filter_plugin/util.py b/mkdocs_file_filter_plugin/util.py
diff --git a/mkdocs_file_filter_plugin/yamlconfig.py b/mkdocs_file_filter_plugin/yamlconfig.py
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/setup.py b/setup.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# MkDocs`
	`2`	`+docs/test/**`
	`3`	`+docs/*/draft-.md`