diff --git a/.copier-answers.yml b/.copier-answers.yml new file mode 100644 index 0000000..7827be5 --- /dev/null +++ b/.copier-answers.yml @@ -0,0 +1,10 @@ +# Changes here will be overwritten by Copier +_commit: ddac80a +_src_path: . +add_extension: js +email: 3105306+timkpaine@users.noreply.github.com +github: python-project-templates +project_description: A JavaScript-Python project template +project_name: js template +python_version_primary: '3.11' +team: Python Project Template Authors diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..31c8297 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,15 @@ +examples/* linguist-documentation +docs/* linguist-documentation +*.ipynb linguist-documentation +Makefile linguist-documentation + +*.css text=auto eol=lf +*.html text=auto eol=lf +*.js text=auto eol=lf +*.json text=auto eol=lf +*.less text=auto eol=lf +*.md text=auto eol=lf +*.py text=auto eol=lf +*.toml text=auto eol=lf +*.ts text=auto eol=lf +*.yml text=auto eol=lf diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d07d5b8 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at 3105306+timkpaine@users.noreply.github.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..42cac77 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,16 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + labels: + - "part: github_actions" + + - package-ecosystem: "pip" + directory: "/" + schedule: + interval: "monthly" + labels: + - "lang: python" + - "part: dependencies" diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..448d48e --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,92 @@ + +name: Build Status + +on: + push: + branches: + - main + tags: + - v* + paths-ignore: + - LICENSE + - README.md + pull_request: + branches: + - main + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +permissions: + contents: read + checks: write + pull-requests: write + +jobs: + build: + runs-on: ${{ matrix.os }} + + strategy: + matrix: + os: [ubuntu-latest] + python-version: ["3.11"] + node-version: [20.x] + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'pyproject.toml' + + - name: Install pnpm + uses: pnpm/action-setup@v4 + with: + version: 9 + package_json_file: js/package.json + + - name: Install dependencies + run: make develop + + - name: Lint + run: make lint + if: ${{ matrix.os == 'ubuntu-latest' }} + + - name: Checks + run: make checks + if: ${{ matrix.os == 'ubuntu-latest' }} + + - name: Build + run: make build + + - name: Test + run: make coverage + if: ${{ matrix.os == 'ubuntu-latest' }} + + - name: Upload test results + uses: actions/upload-artifact@v4 + with: + name: test-results-${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.node-version }} + path: | + **/junit.xml + if: ${{ always() }} + + - name: Publish Unit Test Results + uses: EnricoMi/publish-unit-test-result-action@v2 + with: + files: | + **/junit.xml + if: ${{ matrix.os == 'ubuntu-latest' }} + + - name: Upload coverage + uses: codecov/codecov-action@v4 + + - name: Make dist + run: make dist + if: ${{ matrix.os == 'ubuntu-latest' }} + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..796c587 --- /dev/null +++ b/.gitignore @@ -0,0 +1,147 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so +*.dll + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +junit.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# PyBuilder +target/ + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# Documentation +docs/_build/ +/site +docs/api +docs/index.md +_template/labextension + +# JS +js/node_modules +js/dist +js_template/extension + +# Jupyter +.ipynb_checkpoints +.autoversion + +# Mac +.DS_Store + +# Rust +target diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..297c43c --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 Python Project Template Authors + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d3af4a7 --- /dev/null +++ b/Makefile @@ -0,0 +1,156 @@ +######### +# BUILD # +######### +.PHONY: develop-py develop-js develop +develop-py: + python -m pip install -e .[develop] + +develop-js: + cd js; pnpm install && npx playwright install + +develop: develop-js develop-py ## setup project for development + +.PHONY: build-py build-js build +build-py: + python -m build -w -n + +build-js: + cd js; pnpm build + +build: build-js build-py ## build the project + +.PHONY: install +install: ## install python library + python -m pip install . + +######### +# LINTS # +######### +.PHONY: lint-py lint-js lint lints +lint-py: ## run python linter with ruff + python -m ruff check js_template + python -m ruff format --check js_template + +lint-js: ## run js linter + cd js; pnpm lint + +lint: lint-js lint-py ## run project linters + +# alias +lints: lint + +.PHONY: fix-py fix-js fix format +fix-py: ## fix python formatting with ruff + python -m ruff check --fix js_template + python -m ruff format js_template + +fix-js: ## fix js formatting + cd js; pnpm fix + +fix: fix-js fix-py ## run project autoformatters + +# alias +format: fix + +################ +# Other Checks # +################ +.PHONY: check-manifest checks check annotate + +check-manifest: ## check python sdist manifest with check-manifest + check-manifest -v + +checks: check-manifest + +# alias +check: checks + +annotate: ## run python type annotation checks with mypy + python -m mypy ./js_template + +######### +# TESTS # +######### +.PHONY: test-py tests-py coverage-py +test-py: ## run python tests + python -m pytest -v js_template/tests --junitxml=junit.xml + +# alias +tests-py: test-py + +coverage-py: ## run python tests and collect test coverage + python -m pytest -v js_template/tests --junitxml=junit.xml --cov=js_template --cov-branch --cov-fail-under=50 --cov-report term-missing --cov-report xml + +.PHONY: test-js tests-js coverage-js +test-js: ## run js tests + cd js; pnpm test + +# alias +tests-js: test-js + +coverage-js: test-js ## run js tests and collect test coverage + +.PHONY: test coverage tests +test: test-py test-js ## run all tests +coverage: coverage-py coverage-js ## run all tests and collect test coverage + +# alias +tests: test + +########### +# VERSION # +########### +.PHONY: show-version patch minor major + +show-version: ## show current library version + @bump-my-version show current_version + +patch: ## bump a patch version + @bump-my-version bump patch + +minor: ## bump a minor version + @bump-my-version bump minor + +major: ## bump a major version + @bump-my-version bump major + +######## +# DIST # +######## +.PHONY: dist dist-build dist-sdist dist-local-wheel publish + +dist-build-py: # build python dists + python -m build -w -s + +dist-build-js: # build js dists + cd js; pnpm pack + +dist-check: ## run python dist checker with twine + python -m twine check dist/* + +dist: clean build dist-build-js dist-build-py dist-check ## build all dists + +publish: dist # publish python assets + +######### +# CLEAN # +######### +.PHONY: deep-clean clean + +deep-clean: ## clean everything from the repository + git clean -fdx + +clean: ## clean the repository + rm -rf .coverage coverage cover htmlcov logs build dist *.egg-info + +############################################################################################ + +.PHONY: help + +# Thanks to Francoise at marmelab.com for this +.DEFAULT_GOAL := help +help: + @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' + +print-%: + @echo '$*=$($*)' diff --git a/README.md b/README.md index 4ca3669..ff936b4 100644 --- a/README.md +++ b/README.md @@ -1 +1,15 @@ -# js \ No newline at end of file +# js template + +A JavaScript-Python project template + +[![Build Status](https://github.com/python-project-templates/js-template/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/js-template/actions/workflows/build.yml) +[![codecov](https://codecov.io/gh/python-project-templates/js-template/branch/main/graph/badge.svg)](https://codecov.io/gh/python-project-templates/js-template) +[![License](https://img.shields.io/github/license/python-project-templates/js-template)](https://github.com/python-project-templates/js-template) +[![PyPI](https://img.shields.io/pypi/v/js-template.svg)](https://pypi.python.org/pypi/js-template) +[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/python-project-templates/js-template/main?urlpath=lab) + +## Overview + + +> \[!NOTE\] +> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base). diff --git a/js/.prettierignore b/js/.prettierignore new file mode 100644 index 0000000..664db10 --- /dev/null +++ b/js/.prettierignore @@ -0,0 +1,2 @@ +*.png +*.svg diff --git a/js/build.mjs b/js/build.mjs new file mode 100644 index 0000000..e7ddd76 --- /dev/null +++ b/js/build.mjs @@ -0,0 +1,95 @@ +import { NodeModulesExternal } from "@finos/perspective-esbuild-plugin/external.js"; +import { build } from "@finos/perspective-esbuild-plugin/build.js"; +import { BuildCss } from "@prospective.co/procss/target/cjs/procss.js"; +import { getarg } from "./tools/getarg.mjs"; +import fs from "fs"; +import cpy from "cpy"; +import path_mod from "path"; + +const DEBUG = getarg("--debug"); + +const COMMON_DEFINE = { + global: "window", + "process.env.DEBUG": `${DEBUG}`, +}; + +const BUILD = [ + { + define: COMMON_DEFINE, + entryPoints: ["src/ts/index.ts"], + plugins: [NodeModulesExternal()], + format: "esm", + loader: { + ".css": "text", + ".html": "text", + }, + outfile: "dist/esm/index.js", + }, + { + define: COMMON_DEFINE, + entryPoints: ["src/ts/index.ts"], + plugins: [], + format: "esm", + loader: { + ".css": "text", + ".html": "text", + }, + outfile: "dist/cdn/index.js", + }, +]; + +async function compile_css() { + const process_path = (path) => { + const outpath = path.replace("src/less", "dist/css"); + fs.mkdirSync(outpath, { recursive: true }); + + fs.readdirSync(path).forEach((file_or_folder) => { + if (file_or_folder.endsWith(".less")) { + const outfile = file_or_folder.replace(".less", ".css"); + const builder = new BuildCss(""); + builder.add( + `${path}/${file_or_folder}`, + fs + .readFileSync(path_mod.join(`${path}/${file_or_folder}`)) + .toString(), + ); + fs.writeFileSync( + `${path.replace("src/less", "dist/css")}/${outfile}`, + builder.compile().get(outfile), + ); + } else { + process_path(`${path}/${file_or_folder}`); + } + }); + }; + // recursively process all less files in src/less + process_path("src/less"); + cpy("src/css/*", "dist/css/"); +} + +async function copy_html() { + fs.mkdirSync("dist/html", { recursive: true }); + cpy("src/html/*", "dist/html"); + // also copy to top level + cpy("src/html/*", "dist/"); +} + +async function copy_img() { + fs.mkdirSync("dist/img", { recursive: true }); + cpy("src/img/*", "dist/img"); +} + +async function copy_to_python() { + fs.mkdirSync("../js_template/extension", { recursive: true }); + cpy("dist/**/*", "../js_template/extension"); +} + +async function build_all() { + await compile_css(); + await copy_html(); + await copy_img(); + await Promise.all(BUILD.map(build)).catch(() => process.exit(1)); + await copy_to_python(); +} + +build_all(); diff --git a/js/package.json b/js/package.json new file mode 100644 index 0000000..9bc7f33 --- /dev/null +++ b/js/package.json @@ -0,0 +1,56 @@ +{ + "name": "js-template", + "version": "0.1.10", + "description": "A JavaScript-Python project template", + "repository": "git@github.com:python-project-templates/js-template.git", + "author": "Python Project Template Authors <3105306+timkpaine@users.noreply.github.com>", + "license": "Apache-2.0", + "private": true, + "type": "module", + "unpkg": "dist/cdn/index.js", + "jsdelivr": "dist/cdn/index.js", + "exports": { + ".": { + "types": "./dist/esm/index.d.ts", + "default": "./dist/esm/index.js" + }, + "./dist/*": "./dist/*", + "./package.json": "./package.json" + }, + "files": [ + "dist/**/*", + "index.d.ts" + ], + "types": "./dist/esm/index.d.ts", + "publishConfig": { + "access": "public" + }, + "scripts": { + "build:debug": "node build.mjs --debug", + "build": "node build.mjs", + "clean": "rm -rf dist playwright-report ../js_template/extension", + "dev": "npm-run-all -p start watch", + "lint": "prettier --check \"src/**/*\" \"tests/**/*\" \"*.mjs\" \"*.json\"", + "fix": "prettier --write \"src/**/*\" \"tests/**/*\" \"*.mjs\" \"*.json\"", + "preinstall": "npx only-allow pnpm", + "prepack": "npm run build", + "start": "http-server -p 3000 -o examples/", + "start:tests": "http-server -p 3000 ", + "test": "TZ=UTC playwright test", + "watch": "nodemon --watch src -e ts,less,html --exec \"pnpm build:debug\"" + }, + "dependencies": {}, + "devDependencies": { + "@finos/perspective-esbuild-plugin": "^2.10.1", + "@playwright/test": "^1.47.0", + "@prospective.co/procss": "^0.1.16", + "cpy": "^11.1.0", + "esbuild": "^0.23.1", + "esbuild-plugin-less": "^1.3.9", + "http-server": "^14.1.1", + "nodemon": "^3.1.4", + "npm-run-all": "^4.1.5", + "prettier": "^3.3.3", + "typescript": "^5.6.2" + } +} diff --git a/js/playwright.config.js b/js/playwright.config.js new file mode 100644 index 0000000..e49718b --- /dev/null +++ b/js/playwright.config.js @@ -0,0 +1,30 @@ +import { defineConfig, devices } from "@playwright/test"; + +export default defineConfig({ + testDir: "tests", + fullyParallel: true, + forbidOnly: !!process.env.CI, + retries: process.env.CI ? 2 : 0, + workers: process.env.CI ? 1 : undefined, + reporter: [ + ["line"], + ["html", { outputFile: "playwright-report/index.html", open: "never" }], + ["junit", { outputFile: "junit.xml" }], + ], + use: { + baseURL: "http://127.0.0.1:3000", + trace: "on-first-retry", + }, + projects: [ + { + name: "chromium", + use: { ...devices["Desktop Chrome"] }, + }, + ], + webServer: { + command: "yarn start:tests", + url: "http://127.0.0.1:3000", + reuseExistingServer: !process.env.CI, + timeout: 120 * 1000, + }, +}); diff --git a/js/src/html/index.html b/js/src/html/index.html new file mode 100644 index 0000000..ee1a1d1 --- /dev/null +++ b/js/src/html/index.html @@ -0,0 +1,13 @@ + + + + js-template + + + + + + + + + diff --git a/js/src/less/index.less b/js/src/less/index.less new file mode 100644 index 0000000..e69de29 diff --git a/js/src/ts/css.d.ts b/js/src/ts/css.d.ts new file mode 100644 index 0000000..31058d4 --- /dev/null +++ b/js/src/ts/css.d.ts @@ -0,0 +1,4 @@ +declare module "*.css" { + const content: string; + export default content; +} diff --git a/js/src/ts/index.ts b/js/src/ts/index.ts new file mode 100644 index 0000000..e69de29 diff --git a/js/tests/index.spec.js b/js/tests/index.spec.js new file mode 100644 index 0000000..0fa5b16 --- /dev/null +++ b/js/tests/index.spec.js @@ -0,0 +1,7 @@ +import { test, expect } from "@playwright/test"; + +test.describe("Basics", () => { + test("basic", async ({ page }) => { + await expect("").toBe(""); + }); +}); diff --git a/js/tools/getarg.mjs b/js/tools/getarg.mjs new file mode 100644 index 0000000..30793a7 --- /dev/null +++ b/js/tools/getarg.mjs @@ -0,0 +1,23 @@ +export const getarg = (flag, ...args) => { + if (Array.isArray(flag)) { + flag = flag.map((x, i) => x + (args[i] || "")).join(""); + } + const argv = process.argv.slice(2); + if (flag) { + const index = argv.indexOf(flag); + if (index > -1) { + const next = argv[index + 1]; + if (next) { + return next; + } else { + return true; + } + } + } else { + return argv + .map(function (arg) { + return "'" + arg.replace(/'/g, "'\\''") + "'"; + }) + .join(" "); + } + }; \ No newline at end of file diff --git a/js/tsconfig.json b/js/tsconfig.json new file mode 100644 index 0000000..b25bdae --- /dev/null +++ b/js/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "allowImportingTsExtensions": true, + "declaration": true, + "emitDeclarationOnly": true, + "emitDecoratorMetadata": true, + "experimentalDecorators": true, + "isolatedModules": true, + "lib": ["ES2020", "DOM", "DOM.Iterable"], + "module": "ESNext", + "moduleResolution": "Bundler", + "noUnusedLocals": true, + "noUnusedParameters": true, + "noFallthroughCasesInSwitch": true, + "outDir": "./dist/esm", + "resolveJsonModule": true, + "rootDir": ".", + "skipLibCheck": true, + "strict": true, + "target": "ES2020", + "useDefineForClassFields": true + }, + "include": ["./src/ts/*.ts", "./tests/*.ts"] +} diff --git a/js_template/__init__.py b/js_template/__init__.py new file mode 100644 index 0000000..3dc1f76 --- /dev/null +++ b/js_template/__init__.py @@ -0,0 +1 @@ +__version__ = "0.1.0" diff --git a/js_template/tests/test_all.py b/js_template/tests/test_all.py new file mode 100644 index 0000000..d48930f --- /dev/null +++ b/js_template/tests/test_all.py @@ -0,0 +1,5 @@ +from js_template import * # noqa + + +def test_all(): + assert True diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..2531496 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,151 @@ +[build-system] +requires = [ + "hatchling", + "hatch-jupyter-builder", +] +build-backend="hatchling.build" + +[project] +name = "js-template" +authors = [{name = "Python Project Template Authors", email = "3105306+timkpaine@users.noreply.github.com"}] +description="A JavaScript-Python project template" +readme = "README.md" +license = { text = "Apache-2.0" } +version = "0.1.0" +requires-python = ">=3.9" +keywords = [] + +classifiers = [ + "Development Status :: 3 - Alpha", + "Programming Language :: Python :: Implementation :: CPython", + "Programming Language :: Python :: Implementation :: PyPy", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", +] + +dependencies = [] + +[project.urls] +Repository = "https://github.com/python-project-templates/js-template" +Homepage = "https://github.com/python-project-templates/js-template" + +[project.optional-dependencies] +develop = [ + "build", + "bump-my-version", + "check-manifest", + "hatch-jupyter-builder", + "hatchling", + "pytest", + "pytest-cov", + "ruff", + "twine", + "wheel", +] + +[project.scripts] + +[tool.bumpversion] +current_version = "0.1.0" +commit = true +tag = true + +[[tool.bumpversion.files]] +filename = "js_template/__init__.py" +search = '__version__ = "{current_version}"' +replace = '__version__ = "{new_version}"' + +[[tool.bumpversion.files]] +filename = "pyproject.toml" +search = 'version = "{current_version}"' +replace = 'version = "{new_version}"' + +[[tool.bumpversion.files]] +filename = "js/package.json" +search = '"version": "{current_version}"' +replace = '"version": "{new_version}"' + +[tool.check-manifest] +ignore = [ + ".copier-answers.yml", + "js/pnpm-lock.yaml", + "Makefile", + "setup.py", + "js_template/**/*", +] + +[tool.hatch.build] +artifacts = [ + "js_template/extension", +] + +[tool.hatch.build.sources] +src = "/" + +[tool.hatch.build.targets.sdist] +include = [ + "/js_template", + "/js", + "LICENSE", + "README.md", +] +exclude = [ + ".copier-answers.yml", + "/.github", + "/.gitattributes", + "/.gitignore", + "/js/node_modules", +] + +[tool.hatch.build.targets.wheel] +include = [ + "/js_template", +] +exclude = [ + ".copier-answers.yml", + "/.github", + "/.gitattributes", + "/.gitignore", + "/js/node_modules", + "/pyproject.toml", +] + +[tool.hatch.build.hooks.jupyter-builder] +build-function = "hatch_jupyter_builder.npm_builder" +ensured-targets = [ + "js_template/extension/cdn/index.js", +] +skip-if-exists = [ + "js_template/extension/cdn/index.js", +] +dependencies = [ + "hatch-jupyter-builder", +] + +[tool.hatch.build.hooks.jupyter-builder.build-kwargs] +path = "js" +build_cmd = "build" +npm = "pnpm" + +[tool.pytest.ini_options] +asyncio_mode = "strict" +testpaths = "js_template/tests" + +[tool.ruff] +line-length = 150 + +[tool.ruff.lint] +extend-select = ["I"] + +[tool.ruff.lint.isort] +combine-as-imports = true +default-section = "third-party" +known-first-party = ["js_template"] +section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"] + +[tool.ruff.lint.per-file-ignores] +"__init__.py" = ["F401"] diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..aefdf20 --- /dev/null +++ b/setup.py @@ -0,0 +1 @@ +__import__("setuptools").setup()