lark-parser · yarikoptic · Feb 14, 2024 · Feb 14, 2024 · Feb 14, 2024 · Feb 14, 2024
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -0,0 +1,23 @@
+# Codespell configuration is within pyproject.toml
+---
+name: Codespell
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -32,7 +32,9 @@ repos:
       exclude: '(^tests/.*\.lark|\.svg)$'
 
 - repo: https://github.com/codespell-project/codespell
-  rev: v2.2.2
+  # Configuration for codespell is in pyproject.toml
+  rev: v2.2.6
   hooks:
     - id: codespell
-      args: ["-L", "nd,iif,ot,datas"]
+      additional_dependencies:
+        - tomli
diff --git a/README.md b/README.md
@@ -194,3 +194,4 @@
 For anything else, I can be reached by email at erezshin at gmail com.
 
  -- [Erez](https://github.com/erezsh)
+Installating
diff --git a/docs/_static/sppf/sppf.html b/docs/_static/sppf/sppf.html
@@ -161,7 +161,7 @@ <h2 id="structural-properties">Structural Properties</h2>
 
 <p>Packed nodes $(t,k)$ have one or two children. The right child is a symbol node $(x,k,i)$ and the left child (if it exists) is a symbol or intermediate node with label $(s,j,k)$, where $j \leq k \leq i$. Packed nodes have always exactly one parent which is a symbol node or intermediate node.</p>
 
-<p>It is useful to observe that the SPPF is a bipartite graph, with on the one hand the set of intermediate and symbol nodes and on the other hand the set of packed nodes. Therefore edges always go from a node of the first type to a node of the second type, or the other way round. As a consequence, cyles in the SPPF are always of even length.</p>
+<p>It is useful to observe that the SPPF is a bipartite graph, with on the one hand the set of intermediate and symbol nodes and on the other hand the set of packed nodes. Therefore edges always go from a node of the first type to a node of the second type, or the other way round. As a consequence, cycles in the SPPF are always of even length.</p>
 
 <h2 id="transformation-to-an-abstract-syntax-tree">Transformation to an abstract syntax tree</h2>
 

diff --git a/examples/composition/main.py b/examples/composition/main.py
@@ -15,7 +15,7 @@
    The resulting transformer can evaluate both JSON and CSV in the parse tree.
 
   The methods of each transformer are renamed into their appropriate namespace, using the given prefix.
-  This approach allows full re-use: the transformers don't need to care if their grammar is used directly,
+  This approach allows full reuse: the transformers don't need to care if their grammar is used directly,
   or being imported, or who is doing the importing.
 
 """

diff --git a/pyproject.toml b/pyproject.toml
@@ -95,3 +95,9 @@ exclude_lines = [
 ]
 [tool.pyright]
 include = ["lark"]
+
+[tool.codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = '.git,*.pdf,*.svg'
+check-hidden = true
+ignore-words-list = 'nd,iif,ot,datas,foor'
Original file line number	Diff line number	Diff line change
Expand Up		@@ -194,3 +194,4 @@
		For anything else, I can be reached by email at erezshin at gmail com.

		-- [Erez](https://github.com/erezsh)
		Installating
Check failure on line 197 in README.md View workflow job for this annotation GitHub Actions / Check for spelling errors `Installating ==> Installing`
Copy link Member erezsh Feb 15, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Huh? Copy link Author yarikoptic Feb 15, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. See the TODOs above ;) it was added explicitly in a commit to see if you do pre-commit checking some how (e.g. via github integration or workflow). Apparently you do, but in a Python type check and not a dedicated workflow. So in principle I can remove dedicated workflow here OR separate our "Python type check" into two -- 2nd one would just run pre-commit and have a clear/different name. WDYT? Copy link Member erezsh Feb 16, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. What would you say are the pros and cons of each approach? Copy link Author yarikoptic Feb 16, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Having dedicated codespell action makes it clear/easy to find what failed the CI since name of it (codespell) says it all. When it is bundled in another action (`pre-commit`) - it not immediately clear. If it is bundled somehow in `Python type check` then it becomes even misleading. I personally would have removed codespell action (duplicates what pre-commit does anyways) separated pre-commit into a dedicated workflow: it is expected for it to never fail since it is expected that it would be ran by contributors locally first. And even if it fails -- it is "low priority" since typically only formatting etc aspects, and thus even lower than "Type Checking" Copy link Author yarikoptic Feb 16, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. And I am not too familiar with the https://pre-commit.ci/ service to advice on that Copy link Member erezsh Feb 17, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Well, one big disadvantage with your proposal is that now instead of only having to run pre-commit, which can run automatically before each commit, contributors would have to run two things, the second one manually. They would only see the error after they open a pull request, instead of seeing it locally when they try to commit. @MegaIng What do you think? Copy link Author yarikoptic Feb 17, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. We might be misunderstanding... I added pre-commit for codespell, nothing to be ran manually Copy link Author yarikoptic Feb 17, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Try to add new popular typo!