diff --git a/.cspell.json b/.cspell.json index f81e969..09ee88e 100644 --- a/.cspell.json +++ b/.cspell.json @@ -1,4 +1,5 @@ { + "language": "en", "dictionaries": [ "aws", "bash", @@ -7,25 +8,7 @@ "misc", "softwareTerms" ], - "ignorePaths": [ - "__pycache__", - ".DS_Store", - ".git", - ".gitignore", - ".husky", - ".mypy_cache", - ".pytest_cache", - ".thx", - ".yarn", - "*.egg-info", - "coverage", - "dist", - "docs/*.css", - "node_modules", - "venv", - "yarn-error.log" - ], - "language": "en", + "ignorePaths": [".git"], "words": [ "autoapi", "autoflake", @@ -38,11 +21,11 @@ "cppclean", "cppdefines", "cpppath", + "cpppaths", "cxxcomstr", "cxxflags", "debugpy", "doctest", - "doxyfile", "emojize", "furo", "giphy", @@ -50,10 +33,9 @@ "gtest", "isort", "lefkowitz", + "libpaths", "linkcomstr", - "mainpage", "matplotlib", - "mdfile", "miniscons", "mypy", "opengraph", @@ -66,16 +48,13 @@ "pytest", "scons", "sdist", - "searchengine", "searchindex", "sphinxext", - "stylesheet", "toctree", - "treeview", "trufflehog", "undoc", "venv", - "walkmate", - "werror" + "werror", + "walkmate" ] } diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f27addd..690e1fb 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,7 +14,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout the source code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Install dependencies uses: ./.github/actions/install diff --git a/.prettierignore b/.prettierignore deleted file mode 100644 index d7f7a42..0000000 --- a/.prettierignore +++ /dev/null @@ -1 +0,0 @@ -.mypy_cache diff --git a/README.md b/README.md index ec7b07b..a1ac3ee 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,6 @@ SCons builders. ![Quality](https://img.shields.io/codacy/grade/97f4a968fe554186b58c2f49903a09f4) ![Coverage](https://img.shields.io/codacy/coverage/97f4a968fe554186b58c2f49903a09f4) - ## Motivation When writing an `SConstruct.py` configuration it is difficult to: @@ -136,7 +135,7 @@ if GetOption("dump"): Now if we run -```sh +```bash scons --dump ``` @@ -172,6 +171,14 @@ Some scripts need access to the include paths that appear in the `SConstruct.py` ## Tooling +### Dependencies + +To install dependencies: + +```bash +pip install .[all] +``` + ### Tests To run tests: @@ -224,8 +231,8 @@ bump2version patch Lots of love to the open source community! -

+

Be kind to your mind Love each other It's ok to have a bad day -

+
diff --git a/package.json b/package.json index 3f0aa56..68a1f9d 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "packageManager": "yarn@4.1.1", "scripts": { - "postinstall": "husky install" + "postinstall": "husky" }, "devDependencies": { "cspell": "^8.0.0", diff --git a/pyproject.toml b/pyproject.toml index 05db1e5..c3a67e4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -54,8 +54,8 @@ file = "README.md" content-type = "text/markdown" [project.urls] -homepage = "https://joellefkowitz.github.io/miniscons" repository = "https://github.com/JoelLefkowitz/miniscons" +homepage = "https://joellefkowitz.github.io/miniscons" [[project.authors]] name = "Joel Lefkowitz" @@ -79,7 +79,7 @@ src = "miniscons" [tool.thx.jobs] lint = [ - "npx cspell . --dot", + "npx cspell . --dot --gitignore", "pylint src --disable=C0114,C0115,C0116,C0411,C3001", "mypy -m src --ignore-missing-import", "trufflehog3", diff --git a/src/build.py b/src/build.py index 4077d0b..883de81 100644 --- a/src/build.py +++ b/src/build.py @@ -32,6 +32,8 @@ def nodes(self, env: Environment) -> list[str]: ] def register(self, env: Environment) -> None: + # TODO: Include the CPPPATHS and LIBPATHS too: + # TODO: Make this conan-agnostic too: libs = env["LIBS"] + self.libs if self.shared: diff --git a/src/environment.py b/src/environment.py index 937a824..1ed0c04 100644 --- a/src/environment.py +++ b/src/environment.py @@ -24,6 +24,7 @@ def conan( num_jobs=psutil.cpu_count(), ) + # TODO: Create a separate function to provide all the include and lib paths includes = [ include for dependency in exported.values() diff --git a/test/test_script.py b/test/test_script.py index c6f1937..002b22a 100644 --- a/test/test_script.py +++ b/test/test_script.py @@ -6,4 +6,4 @@ def test_action(): assert clang_format.action == "clang-format -i main.cpp main.hpp" cspell = Script("cspell", [".", "--dot"], ["npx"]) - assert cspell.action == "npx cspell . --dot" + assert cspell.action == "npx cspell . --dot --gitignore"