stylebook 0.1__py3-none-any.whl

stylebook/__init__.py

@@ -0,0 +1 @@
+"""main"""

stylebook/__main__.py

@@ -0,0 +1,4 @@
+from stylebook.cli import run
+
+if __name__ == '__main__':
+    run()

stylebook/cli.py

@@ -0,0 +1,46 @@
+from pathlib import Path
+from sys import argv, exit, stderr
+
+from stylebook.commands import Command, SqlfluffCommand, TaploCommand, YamllintCommand
+
+
+def walk(target_path: Path) -> list[str]:
+    if target_path.is_file():
+        return [str(target_path)]
+    if target_path.is_dir():
+        results = []
+        for child in target_path.iterdir():
+            results.extend(walk(child))
+        return results
+    return []
+
+
+def run() -> None:
+    input_args: list[str] = argv[1:]
+    if not input_args:
+        print('Need a path.', file=stderr)
+        exit(1)
+
+    sqlfluff_command: Command = SqlfluffCommand()
+    taplo_command: Command = TaploCommand()
+    yamllint_command: Command = YamllintCommand()
+    commands: dict[Command, list[str]] = {
+        sqlfluff_command: [],
+        taplo_command: [],
+        yamllint_command: [],
+    }
+    for target_path in [path for arg in input_args for path in walk(Path(arg))]:
+        match Path(target_path).suffix.lower():
+            case '.sql':
+                commands[sqlfluff_command].append(target_path)
+            case '.toml':
+                commands[taplo_command].append(target_path)
+            case '.yaml' | '.yml':
+                commands[yamllint_command].append(target_path)
+
+    exit(
+        min(
+            1,
+            sum(command.execute(paths) for command, paths in commands.items() if paths),
+        ),
+    )

stylebook/commands/__init__.py

@@ -0,0 +1,11 @@
+from stylebook.commands.command import Command
+from stylebook.commands.sqlfluff import SqlfluffCommand
+from stylebook.commands.taplo import TaploCommand
+from stylebook.commands.yamllint import YamllintCommand
+
+__all__: list[str] = [
+    'Command',
+    'SqlfluffCommand',
+    'TaploCommand',
+    'YamllintCommand',
+]

stylebook/commands/command.py

@@ -0,0 +1,26 @@
+from abc import ABC, abstractmethod
+from importlib.resources import files
+from pathlib import Path
+from subprocess import run
+
+
+class Command(ABC):
+    def __init__(self, binary: str, config_file: str) -> None:
+        self.binary = binary
+        local_config_file: Path = Path.cwd() / f'.{config_file}'
+        self.config_file = \
+            str(
+                local_config_file
+                if local_config_file.exists()
+                else files('stylebook.resources').joinpath(config_file),
+            )
+
+    @abstractmethod
+    def get_arguments(self) -> list[str]:
+        pass
+
+    def execute(self, target_paths: list[str]) -> int:
+        return run(
+            [self.binary, *self.get_arguments(), *target_paths],
+            capture_output=False,
+        ).returncode

stylebook/commands/sqlfluff.py

@@ -0,0 +1,9 @@
+from stylebook.commands import Command
+
+
+class SqlfluffCommand(Command):
+    def __init__(self):
+        super().__init__('sqlfluff', 'sqlfluff')
+
+    def get_arguments(self) -> list[str]:
+        return ['lint', '--config', self.config_file]

stylebook/commands/taplo.py

@@ -0,0 +1,9 @@
+from stylebook.commands import Command
+
+
+class TaploCommand(Command):
+    def __init__(self):
+        super().__init__('taplo', 'taplo.toml')
+
+    def get_arguments(self) -> list[str]:
+        return ['fmt', '--diff', '-c', self.config_file]

stylebook/commands/yamllint.py

@@ -0,0 +1,9 @@
+from stylebook.commands import Command
+
+
+class YamllintCommand(Command):
+    def __init__(self) -> None:
+        super().__init__('yamllint', 'yamllintrc.yaml')
+
+    def get_arguments(self) -> list[str]:
+        return ['-c', self.config_file]

stylebook/resources/sqlfluff

@@ -0,0 +1,30 @@
+[sqlfluff]
+dialect = snowflake
+templater = jinja
+exclude_rules = ambiguous.column_count, structure.column_order
+max_line_length = 80
+processes = -1
+
+[sqlfluff:templater:dbt]
+project_dir = ./
+
+[sqlfluff:indentation]
+implicit_indents = allow
+tab_space_size = 2
+
+[sqlfluff:rules:aliasing.length]
+min_alias_length = 3
+
+[sqlfluff:rules:capitalisation.keywords]
+capitalisation_policy = upper
+[sqlfluff:rules:capitalisation.identifiers]
+extended_capitalisation_policy = lower
+[sqlfluff:rules:capitalisation.functions]
+extended_capitalisation_policy = lower
+[sqlfluff:rules:capitalisation.literals]
+capitalisation_policy = upper
+[sqlfluff:rules:capitalisation.types]
+extended_capitalisation_policy = upper
+
+[sqlfluff:rules:convention.not_equal]
+preferred_not_equal_style = c_style

stylebook/resources/taplo.toml

@@ -0,0 +1,3 @@
+[formatting]
+allowed_blank_lines = 1
+array_auto_collapse = false

stylebook/resources/yamllintrc.yaml

@@ -0,0 +1,14 @@
+extends: default
+
+rules:
+  document-start: disable
+  empty-lines:
+    max: 1
+  empty-values: enable
+  indentation:
+    spaces: 2
+    indent-sequences: whatever
+  float-values: enable
+  octal-values: enable
+  truthy:
+    check-keys: false

stylebook-0.1.dist-info/METADATA

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: stylebook
+Version: 0.1
+Summary: Permissive linter extensions for markup and data languages
+Project-URL: Source Code, https://github.com/hanggrian/stylebook
+Project-URL: Bug Tracker, https://github.com/hanggrian/stylebook/issues
+Author-email: Hendra Anggrian <hanggrian@proton.me>
+License: Apache-2.0
+Keywords: lint,linter,sql,toml,yaml
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: sqlfluff==4.1.0
+Requires-Dist: taplo==0.9.3
+Requires-Dist: yamllint==1.38.0
+Description-Content-Type: text/markdown
+
+[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/hanggrian/stylebook/code-analysis.yaml)](https://github.com/hanggrian/stylebook/actions/workflows/code-analysis.yaml)
+[![Codecov](https://img.shields.io/codecov/c/gh/hanggrian/stylebook)](https://app.codecov.io/gh/hanggrian/stylebook/)
+[![Renovate](https://img.shields.io/badge/dependency-mend-blue)](https://developer.mend.io/github/hanggrian/stylebook/)\
+[![PyPI](https://shields.io/pypi/v/stylebook)](https://pypi.org/project/stylebook/)
+[![TestPyPI](https://shields.io/pypi/v/stylebook?label=testpypi&pypiBaseUrl=https://test.pypi.org)](https://test.pypi.org/project/stylebook/)
+[![Python](https://img.shields.io/badge/python-3.10+-informational)](https://docs.python.org/3.10/)\
+[![NPM](https://shields.io/npm/v/@hanggrian/stylebook)](https://www.npmjs.com/package/@hanggrian/stylebook/)
+[![Node](https://img.shields.io/badge/node-12+-informational)](https://nodejs.org/en/blog/release/v12.0.0/)
+
+# Stylebook
+
+![The Stylebook logo.](https://github.com/hanggrian/stylebook/raw/assets/logo.svg)
+
+Third-party linter rules and configuration for various data formats not
+considered as a programming language.
+
+<table>
+  <thead>
+    <tr>
+      <th>Runner</th>
+      <th>File type</th>
+      <th>Linter</th>
+      <th>Style</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td rowspan="3">Python</td>
+      <td>SQL</td>
+      <td>
+        <a href="https://github.com/sqlfluff/sqlfluff/">
+          SQLFluff
+        </a>
+      </td>
+      <td>
+        <a href="https://docs.telemetry.mozilla.org/concepts/sql_style/">
+          Mozilla SQL Style Guide
+        </a>
+      </td>
+    </tr>
+    <tr>
+      <td>TOML</td>
+      <td>
+        <a href="https://github.com/tamasfe/taplo/">
+          Taplo
+        </a>
+      </td>
+      <td>
+        <a href="https://toml.io/en/">
+          TOML Spec
+        </a>
+      </td>
+    </tr>
+    <tr>
+      <td>YAML</td>
+      <td>
+        <a href="https://github.com/adrienverge/yamllint/">
+          yamllint
+        </a>
+      </td>
+      <td>
+        <a href="https://yaml.org/spec/">
+          YAML Spec
+        </a>
+      </td>
+    </tr>
+    <tr>
+      <td rowspan="4">Node</td>
+      <td>CSS</td>
+      <td>
+        <a href="https://github.com/stylelint/stylelint/">
+          Stylelint
+        </a>
+      </td>
+      <td>
+        <a href="https://protocol.mozilla.org/docs/contributing/css-guide/">
+          Mozilla HTML Coding Guide
+        </a>
+      </td>
+    </tr>
+    <tr>
+      <td>HTML</td>
+      <td>
+        <a href="https://github.com/htmlhint/HTMLHint/">
+          HTMLHint
+        </a>
+      </td>
+      <td>
+        <a href="https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Code_style_guide/HTML/">
+          Mozilla HTML Style Guide
+        </a>
+      </td>
+    </tr>
+    <tr>
+      <td>JSON</td>
+      <td>
+        <a href="https://github.com/prantlf/jsonlint/">
+          JSON Lint
+        </a>
+      </td>
+      <td>
+        <a href="https://spec.json5.org/">
+          JSON5 Spec
+        </a>
+      </td>
+    </tr>
+    <tr>
+      <td>Markdown</td>
+      <td>
+        <a href="https://github.com/davidanson/markdownlint/">
+          markdownlint
+        </a>
+      </td>
+      <td>
+        <a href="https://github.github.com/gfm/">
+          GitHub Flavored Markdown Spec
+        </a>
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+## Download
+
+### PyPI
+
+```sh
+pip install stylebook-data
+```
+
+### NPM
+
+```sh
+npm install stylebook-markup \
+  stylelint @stylistic/stylelint-plugin stylelint-config-recommended \
+  @prantlf/jsonlint \
+  markdownlint markdownlint-cli2 --save-dev
+```
+
+## Usage
+
+Insert target paths into the command. The program will recursively search for
+qualifying file types and spawn the corresponding linter processes.
+
+```sh
+npm exec stylebook some-folder/ some-file.sql
+source .venv/bin/activate && stylebook **/* # or use uv run
+```
+
+### SQLFluff
+
+No setup is necessary. However, to customize behaviors, a local
+`.sqlfluff` is needed.
+
+### tomllint
+
+No setup is necessary. However, to customize behaviors, a local
+`.taplo.toml` is needed.
+
+### yamllint
+
+No setup is necessary. However, to customize behaviors, a local
+`.yamllintrc.json` is needed.
+
+### Stylelint
+
+Create `.stylint.config.js` file in the root directory.
+
+### HTML Hint
+
+No setup is necessary. However, to customize behaviors, a local
+`.htmlhintrc` is needed.
+
+### JSON Lint
+
+No setup is necessary. However, to customize behaviors, a local
+`.jsonlintrc.config.json` is needed.
+
+### markdownlint
+
+No setup is necessary. However, to customize behaviors, a local
+`.markdownlint-cli2.json` is needed.

stylebook-0.1.dist-info/RECORD

@@ -0,0 +1,15 @@
+stylebook/__init__.py,sha256=GdezVuMnjMXj_Ig_uYJRxBuNTb9ghpl_klOnk2SpkG4,11
+stylebook/__main__.py,sha256=yigECWPJNabtOHpiJTGnFsf5simenlscbzrNCLzYQoQ,68
+stylebook/cli.py,sha256=jmBnouC5bXUYTnpuPcOW_myvPl02DYI_i3PMXKtgdgI,1394
+stylebook/commands/__init__.py,sha256=Baucdvu-6dCsDHepg82oDc_nIJa-_iem3kzjClAG0i8,316
+stylebook/commands/command.py,sha256=uBMOBarfkZNjytQlvEJaL9HCvqLO7D26keO1BovUmAc,790
+stylebook/commands/sqlfluff.py,sha256=6vrkXuqbIRnTW43Ap7Q8EkGTY40B0QOnbvASPj67ECc,243
+stylebook/commands/taplo.py,sha256=KxWcmwVkPZogPN6yitYMH2CD9uigV4ndJkZD-2m_6uE,242
+stylebook/commands/yamllint.py,sha256=qSrlwQL67rUsqoYY1O_g7XuiPCuV1B1UyScq6BbtmJI,244
+stylebook/resources/sqlfluff,sha256=zdEKzjjMvOKHDi-4_gZp4-rkZmWrtrCDJV6GpoEAg7E,773
+stylebook/resources/taplo.toml,sha256=t-auffFTUh6Y9eqQ_uzkIrgfcpoWgnXC4fI-oI8YPuc,65
+stylebook/resources/yamllintrc.yaml,sha256=tVsEVhvTMlrBnjcp9CDZKesTl2MPy4QMoFB8yhbKrKs,238
+stylebook-0.1.dist-info/METADATA,sha256=1Ws8EYVpTMeSzUrzBOnvRMxyCE8iniG_kvMbem9QrHo,5304
+stylebook-0.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+stylebook-0.1.dist-info/entry_points.txt,sha256=17WUzJtMFGG7U4qxDxAUbs2T932nFlaauksx46Zb_00,48
+stylebook-0.1.dist-info/RECORD,,

stylebook-0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

stylebook-0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+stylebook = stylebook.cli:run