wexample-wex-addon-dev-javascript 0.0.55__tar.gz → 0.0.56__tar.gz

{wexample_wex_addon_dev_javascript-0.0.55 → wexample_wex_addon_dev_javascript-0.0.56}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wexample-wex-addon-dev-javascript
-Version: 0.0.55
+Version: 0.0.56
 Summary: Python dev addon for wex
 Author-Email: weeger <contact@wexample.com>
 License: MIT
@@ -11,8 +11,9 @@ Project-URL: homepage, https://github.com/wexample/python-wex-dev-python
 Requires-Python: >=3.10
 Requires-Dist: attrs>=23.1.0
 Requires-Dist: cattrs>=23.1.0
-Requires-Dist: wexample-wex-addon-app==0.0.53
-Requires-Dist: wexample-wex-core==6.0.65
+Requires-Dist: wexample-filestate-javascript==0.0.13
+Requires-Dist: wexample-wex-addon-app==0.0.54
+Requires-Dist: wexample-wex-core==6.0.66
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
@@ -20,10 +21,49 @@ Description-Content-Type: text/markdown
 
 # wexample-wex-addon-dev-javascript
 
-Version: 0.0.55
+Version: 0.0.56
 
 Python dev addon for wex
 
+## Table of Contents
+
+- [Status Compatibility](#status-compatibility)
+- [Api Reference](#api-reference)
+- [Tests](#tests)
+- [Code Quality](#code-quality)
+- [Versioning](#versioning)
+- [Changelog](#changelog)
+- [Migration Notes](#migration-notes)
+- [Roadmap](#roadmap)
+- [Security](#security)
+- [Privacy](#privacy)
+- [Support](#support)
+- [Contribution Guidelines](#contribution-guidelines)
+- [Maintainers](#maintainers)
+- [License](#license)
+- [Useful Links](#useful-links)
+- [Suite Integration](#suite-integration)
+- [Compatibility Matrix](#compatibility-matrix)
+- [Dependencies](#dependencies)
+- [Suite Signature](#suite-signature)
+
+
+## Status & Compatibility
+
+**Maturity**: Production-ready
+
+**Python Support**: >=3.10
+
+**OS Support**: Linux, macOS, Windows
+
+**Status**: Actively maintained
+
+## API Reference
+
+Full API documentation is available in the source code docstrings.
+
+Key modules and classes are documented with type hints for better IDE support.
+
 ## Tests
 
 This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
@@ -110,13 +150,13 @@ Breaking changes are clearly documented with upgrade paths and examples.
 
 Current limitations and planned features are tracked in the GitHub issues.
 
-See the [project roadmap](https://github.com/wexample/python-wex-dev-python/issues) for upcoming features and improvements.
+See the [project roadmap](https://github.com/wexample/python-wex_addon_dev_javascript/issues) for upcoming features and improvements.
 
 ## Security Policy
 
 ### Reporting Vulnerabilities
 
-If you discover a security vulnerability, please email security@wexample.com.
+If you discover a security vulnerability, please email contact@wexample.com.
 
 **Do not** open public issues for security vulnerabilities.
 
@@ -139,7 +179,7 @@ Community support is available through GitHub Discussions.
 
 ## Contribution Guidelines
 
-We welcome contributions to the Wexample suite! 
+We welcome contributions to the Wexample suite!
 
 ### How to Contribute
 
@@ -157,14 +197,16 @@ See [CONTRIBUTORS.md](CONTRIBUTORS.md) for the full list of contributors.
 
 ## License
 
-MIT
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+Free to use in both personal and commercial projects.
 
 ## Useful Links
 
-- **Homepage**: https://github.com/wexample/python-wex-dev-python
+- **Homepage**: https://github.com/wexample/python-wex-addon-dev-javascript
 - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
-- **Issue Tracker**: https://github.com/wexample/python-wex-dev-python/issues
-- **Discussions**: https://github.com/wexample/python-wex-dev-python/discussions
+- **Issue Tracker**: https://github.com/wexample/python-wex-addon-dev-javascript/issues
+- **Discussions**: https://github.com/wexample/python-wex-addon-dev-javascript/discussions
 - **PyPI**: [pypi.org/project/wexample-wex-addon-dev-javascript](https://pypi.org/project/wexample-wex-addon-dev-javascript/)
 
 ## Integration in the Suite
@@ -177,9 +219,24 @@ The suite includes packages for configuration management, file handling, prompts
 
 Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
 
+## Compatibility Matrix
+
+This package is part of the Wexample suite and is compatible with other suite packages.
+
+Refer to each package's documentation for specific version compatibility requirements.
+
+## Dependencies
+
+- attrs: >=23.1.0
+- cattrs: >=23.1.0
+- wexample-filestate-javascript: ==0.0.13
+- wexample-wex-addon-app: ==0.0.54
+- wexample-wex-core: ==6.0.66
+
+
 # About us
 
-Wexample stands as a cornerstone of the digital ecosystem — a collective of seasoned engineers, researchers, and creators driven by a relentless pursuit of technological excellence. More than a media platform, it has grown into a vibrant community where innovation meets craftsmanship, and where every line of code reflects a commitment to clarity, durability, and shared intelligence.
+[Wexample](https://wexample.com) stands as a cornerstone of the digital ecosystem — a collective of seasoned engineers, researchers, and creators driven by a relentless pursuit of technological excellence. More than a media platform, it has grown into a vibrant community where innovation meets craftsmanship, and where every line of code reflects a commitment to clarity, durability, and shared intelligence.
 
 This packages suite embodies this spirit. Trusted by professionals and enthusiasts alike, it delivers a consistent, high-quality foundation for modern development — open, elegant, and battle-tested. Its reputation is built on years of collaboration, refinement, and rigorous attention to detail, making it a natural choice for those who demand both robustness and beauty in their tools.
 

{wexample_wex_addon_dev_javascript-0.0.55 → wexample_wex_addon_dev_javascript-0.0.56}/README.md

@@ -1,9 +1,48 @@
 # wexample-wex-addon-dev-javascript
 
-Version: 0.0.55
+Version: 0.0.56
 
 Python dev addon for wex
 
+## Table of Contents
+
+- [Status Compatibility](#status-compatibility)
+- [Api Reference](#api-reference)
+- [Tests](#tests)
+- [Code Quality](#code-quality)
+- [Versioning](#versioning)
+- [Changelog](#changelog)
+- [Migration Notes](#migration-notes)
+- [Roadmap](#roadmap)
+- [Security](#security)
+- [Privacy](#privacy)
+- [Support](#support)
+- [Contribution Guidelines](#contribution-guidelines)
+- [Maintainers](#maintainers)
+- [License](#license)
+- [Useful Links](#useful-links)
+- [Suite Integration](#suite-integration)
+- [Compatibility Matrix](#compatibility-matrix)
+- [Dependencies](#dependencies)
+- [Suite Signature](#suite-signature)
+
+
+## Status & Compatibility
+
+**Maturity**: Production-ready
+
+**Python Support**: >=3.10
+
+**OS Support**: Linux, macOS, Windows
+
+**Status**: Actively maintained
+
+## API Reference
+
+Full API documentation is available in the source code docstrings.
+
+Key modules and classes are documented with type hints for better IDE support.
+
 ## Tests
 
 This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
@@ -90,13 +129,13 @@ Breaking changes are clearly documented with upgrade paths and examples.
 
 Current limitations and planned features are tracked in the GitHub issues.
 
-See the [project roadmap](https://github.com/wexample/python-wex-dev-python/issues) for upcoming features and improvements.
+See the [project roadmap](https://github.com/wexample/python-wex_addon_dev_javascript/issues) for upcoming features and improvements.
 
 ## Security Policy
 
 ### Reporting Vulnerabilities
 
-If you discover a security vulnerability, please email security@wexample.com.
+If you discover a security vulnerability, please email contact@wexample.com.
 
 **Do not** open public issues for security vulnerabilities.
 
@@ -119,7 +158,7 @@ Community support is available through GitHub Discussions.
 
 ## Contribution Guidelines
 
-We welcome contributions to the Wexample suite! 
+We welcome contributions to the Wexample suite!
 
 ### How to Contribute
 
@@ -137,14 +176,16 @@ See [CONTRIBUTORS.md](CONTRIBUTORS.md) for the full list of contributors.
 
 ## License
 
-MIT
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+Free to use in both personal and commercial projects.
 
 ## Useful Links
 
-- **Homepage**: https://github.com/wexample/python-wex-dev-python
+- **Homepage**: https://github.com/wexample/python-wex-addon-dev-javascript
 - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
-- **Issue Tracker**: https://github.com/wexample/python-wex-dev-python/issues
-- **Discussions**: https://github.com/wexample/python-wex-dev-python/discussions
+- **Issue Tracker**: https://github.com/wexample/python-wex-addon-dev-javascript/issues
+- **Discussions**: https://github.com/wexample/python-wex-addon-dev-javascript/discussions
 - **PyPI**: [pypi.org/project/wexample-wex-addon-dev-javascript](https://pypi.org/project/wexample-wex-addon-dev-javascript/)
 
 ## Integration in the Suite
@@ -157,9 +198,24 @@ The suite includes packages for configuration management, file handling, prompts
 
 Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
 
+## Compatibility Matrix
+
+This package is part of the Wexample suite and is compatible with other suite packages.
+
+Refer to each package's documentation for specific version compatibility requirements.
+
+## Dependencies
+
+- attrs: >=23.1.0
+- cattrs: >=23.1.0
+- wexample-filestate-javascript: ==0.0.13
+- wexample-wex-addon-app: ==0.0.54
+- wexample-wex-core: ==6.0.66
+
+
 # About us
 
-Wexample stands as a cornerstone of the digital ecosystem — a collective of seasoned engineers, researchers, and creators driven by a relentless pursuit of technological excellence. More than a media platform, it has grown into a vibrant community where innovation meets craftsmanship, and where every line of code reflects a commitment to clarity, durability, and shared intelligence.
+[Wexample](https://wexample.com) stands as a cornerstone of the digital ecosystem — a collective of seasoned engineers, researchers, and creators driven by a relentless pursuit of technological excellence. More than a media platform, it has grown into a vibrant community where innovation meets craftsmanship, and where every line of code reflects a commitment to clarity, durability, and shared intelligence.
 
 This packages suite embodies this spirit. Trusted by professionals and enthusiasts alike, it delivers a consistent, high-quality foundation for modern development — open, elegant, and battle-tested. Its reputation is built on years of collaboration, refinement, and rigorous attention to detail, making it a natural choice for those who demand both robustness and beauty in their tools.
 

{wexample_wex_addon_dev_javascript-0.0.55 → wexample_wex_addon_dev_javascript-0.0.56}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
 
 [project]
 name = "wexample-wex-addon-dev-javascript"
-version = "0.0.55"
+version = "0.0.56"
 description = "Python dev addon for wex"
 authors = [
     { name = "weeger", email = "contact@wexample.com" },
@@ -20,8 +20,9 @@ classifiers = [
 dependencies = [
     "attrs>=23.1.0",
     "cattrs>=23.1.0",
-    "wexample-wex-addon-app==0.0.53",
-    "wexample-wex-core==6.0.65",
+    "wexample-filestate-javascript==0.0.13",
+    "wexample-wex-addon-app==0.0.54",
+    "wexample-wex-core==6.0.66",
 ]
 
 [project.readme]

wexample_wex_addon_dev_javascript-0.0.56/src/wexample_wex_addon_dev_javascript/config_value/javascript_package_readme_config_value.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from wexample_helpers.decorator.base_class import base_class
+from wexample_wex_addon_app.config_value.app_readme_config_value import (
+    AppReadmeConfigValue,
+)
+
+
+@base_class
+class JavascriptPackageReadmeContentConfigValue(AppReadmeConfigValue):
+    """README generation for Javascript packages."""
+
+    def _get_app_description(self) -> str:
+        return self.workdir.get_app_config().get("description", "")

wexample_wex_addon_dev_javascript-0.0.56/src/wexample_wex_addon_dev_javascript/file/javascript_package_json_file.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_filestate.item.file.json_file import JsonFile
+from wexample_helpers.decorator.base_class import base_class
+
+if TYPE_CHECKING:
+    from wexample_wex_addon_app.workdir.code_base_workdir import CodeBaseWorkdir
+
+
+@base_class
+class JavascriptPackageJsonFile(JsonFile):
+    def get_dependencies_versions(
+        self, optional: bool = False, group: str = "dev"
+    ) -> dict[str, str]:
+        return (
+            self.read_config()
+            .search(path="dependencies")
+            .get_dict_or_default(default={})
+        )
+
+    def dumps(self, content: dict | None = None) -> str:
+        import json
+
+        content = content or self.read_parsed()
+
+        package = self.find_package_workdir()
+        if package:
+            if not content.get("name"):
+                content["name"] = package.get_package_import_name()
+
+            content["version"] = package.get_project_version()
+
+        if not content.get("type"):
+            content["type"] = "module"
+
+        return json.dumps(content or {}, ensure_ascii=False, indent=2)
+
+    def find_package_workdir(self) -> CodeBaseWorkdir | None:
+        from wexample_wex_addon_app.workdir.code_base_workdir import CodeBaseWorkdir
+
+        return self.find_closest(CodeBaseWorkdir)

wexample_wex_addon_dev_javascript-0.0.56/src/wexample_wex_addon_dev_javascript/workdir/javascript_package_workdir.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+import os
+import subprocess
+from typing import TYPE_CHECKING
+
+from wexample_helpers.helpers.string import string_to_kebab_case
+from wexample_wex_addon_dev_javascript.workdir.javascript_workdir import (
+    JavascriptWorkdir,
+)
+
+if TYPE_CHECKING:
+    from wexample_filestate.config_value.readme_content_config_value import (
+        ReadmeContentConfigValue,
+    )
+    from wexample_wex_addon_app.workdir.framework_packages_suite_workdir import (
+        FrameworkPackageSuiteWorkdir,
+    )
+
+
+class JavascriptPackageWorkdir(JavascriptWorkdir):
+    def _get_readme_content(self) -> ReadmeContentConfigValue | None:
+        from wexample_wex_addon_dev_javascript.config_value.javascript_package_readme_config_value import (
+            JavascriptPackageReadmeContentConfigValue,
+        )
+
+        return JavascriptPackageReadmeContentConfigValue(workdir=self)
+
+    def _get_suite_package_workdir_class(self) -> type[FrameworkPackageSuiteWorkdir]:
+        from wexample_wex_addon_dev_javascript.workdir.javascript_packages_suite_workdir import (
+            JavascriptPackagesSuiteWorkdir,
+        )
+
+        return JavascriptPackagesSuiteWorkdir
+
+    def get_package_import_name(self) -> str:
+        """Get the full package import name with vendor prefix."""
+        return (
+            f"@{self.get_vendor_name()}/{string_to_kebab_case(self.get_project_name())}"
+        )
+
+    def _publish(self, force: bool = False) -> None:
+        """Publish the package to npm, skipping if the version already exists."""
+        from wexample_helpers.helpers.shell import shell_run
+
+        package_name = self.get_package_name()
+        version = self.get_project_version()
+        registry = self.get_env_parameter_or_suite_fallback(
+            key="NPM_REGISTRY", default="https://registry.npmjs.org"
+        )
+
+        # Detect if the version already exists on the registry
+        release_exists = False
+        try:
+            shell_run(
+                [
+                    "npm",
+                    "view",
+                    f"{package_name}@{version}",
+                    "version",
+                    "--registry",
+                    registry,
+                ],
+                cwd=self.get_path(),
+                inherit_stdio=False,
+            )
+            release_exists = True
+        except subprocess.CalledProcessError:
+            release_exists = False
+
+        if release_exists and not force:
+            self.warning(
+                f'Trying to publish an existing release for package "{package_name}" version {version}'
+            )
+            return
+
+        token = self.get_env_parameter_or_suite_fallback("NPM_TOKEN")
+        env = os.environ.copy()
+        host = registry.rstrip("/").split("://")[-1]
+
+        if registry:
+            env["npm_config_registry"] = registry
+        if token:
+            env["NPM_TOKEN"] = token
+            env[f"npm_config_//{host}/:_authToken"] = token
+
+        shell_run(
+            ["npm", "publish", "--registry", registry],
+            cwd=self.get_path(),
+            env=env,
+            inherit_stdio=True,
+        )

wexample_wex_addon_dev_javascript-0.0.56/src/wexample_wex_addon_dev_javascript/workdir/javascript_workdir.py

@@ -0,0 +1,130 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from wexample_config.options_provider.abstract_options_provider import (
+    AbstractOptionsProvider,
+)
+from wexample_wex_addon_app.workdir.code_base_workdir import CodeBaseWorkdir
+
+if TYPE_CHECKING:
+    from wexample_config.const.types import DictConfig
+    from wexample_filestate.option.children_file_factory_option import (
+        ChildrenFileFactoryOption,
+    )
+
+    from wexample_wex_addon_dev_javascript.file.javascript_package_json_file import (
+        JavascriptPackageJsonFile,
+    )
+
+
+class JavascriptWorkdir(CodeBaseWorkdir):
+    def get_app_config_file(self, reload: bool = True) -> JavascriptPackageJsonFile:
+        from wexample_wex_addon_dev_javascript.file.javascript_package_json_file import (
+            JavascriptPackageJsonFile,
+        )
+
+        config_file = self.find_by_type(JavascriptPackageJsonFile)
+        # Read once to populate content with file source.
+        config_file.read_text(reload=reload)
+        return config_file
+
+    def get_dependencies_versions(self) -> dict[str, str]:
+        return self.get_app_config_file().get_dependencies_versions()
+
+    def get_main_code_file_extension(self) -> str:
+        return "js"
+
+    def get_options_providers(self) -> list[type[AbstractOptionsProvider]]:
+        from wexample_filestate_javascript.options_provider.javascript_options_provider import (
+            JavascriptOptionsProvider,
+        )
+
+        options = super().get_options_providers()
+
+        options.extend(
+            [
+                JavascriptOptionsProvider,
+            ]
+        )
+
+        return options
+
+    def prepare_value(self, raw_value: DictConfig | None = None) -> DictConfig:
+        from wexample_filestate.const.disk import DiskItemType
+        from wexample_helpers.helpers.array import array_dict_get_by
+
+        from wexample_wex_addon_dev_javascript.file.javascript_package_json_file import (
+            JavascriptPackageJsonFile,
+        )
+
+        raw_value = super().prepare_value(raw_value=raw_value)
+
+        # Ensure a package.json file exists for any JavaScript package project
+        children = raw_value["children"]
+
+        children.append(
+            {
+                "class": JavascriptPackageJsonFile,
+                "name": "package.json",
+                "type": DiskItemType.FILE,
+                "should_exist": True,
+            }
+        )
+
+        # Add rules to .gitignore
+        array_dict_get_by("name", ".gitignore", children).setdefault(
+            "should_contain_lines", []
+        ).extend(
+            [
+                "node_modules/",
+                "dist/",
+                "build/",
+                ".npm",
+                ".eslintcache",
+            ]
+        )
+
+        children.extend(
+            [
+                {
+                    "name": "tests",
+                    "type": DiskItemType.DIRECTORY,
+                    "should_exist": True,
+                    "children": [
+                        self._create_javascript_file_children_filter(),
+                    ],
+                },
+                {
+                    "name": "src",
+                    "type": DiskItemType.DIRECTORY,
+                    "should_exist": True,
+                    "children": [
+                        self._create_javascript_file_children_filter(),
+                    ],
+                },
+            ]
+        )
+
+        return raw_value
+
+    def _create_javascript_file_children_filter(self) -> ChildrenFileFactoryOption:
+        from wexample_filestate.const.disk import DiskItemType
+        from wexample_filestate.option.children_filter_option import (
+            ChildrenFilterOption,
+        )
+        from wexample_filestate_javascript.file.javascript_file import JavascriptFile
+        from wexample_filestate_javascript.option.javascript.biome_option import (
+            BiomeOption,
+        )
+
+        # Using a generic pattern since there's no specific JavascriptFile class yet
+        return ChildrenFilterOption(
+            pattern={
+                "class": JavascriptFile,
+                "type": DiskItemType.FILE,
+                "javascript": [BiomeOption.get_name()],
+            },
+            name_pattern=r"^.*\.(js|jsx|ts|tsx)$",
+            recursive=True,
+        )

wexample_wex_addon_dev_javascript-0.0.55/src/wexample_wex_addon_dev_javascript/workdir/javascript_package_workdir.py

@@ -1,17 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-from wexample_wex_addon_dev_javascript.workdir.javascript_workdir import (
-    JavascriptWorkdir,
-)
-
-if TYPE_CHECKING:
-    from wexample_config.const.types import DictConfig
-
-
-class JavascriptPackageWorkdir(JavascriptWorkdir):
-    def prepare_value(self, raw_value: DictConfig | None = None) -> DictConfig:
-        raw_value = super().prepare_value(raw_value=raw_value)
-
-        return raw_value

wexample_wex_addon_dev_javascript-0.0.55/src/wexample_wex_addon_dev_javascript/workdir/javascript_workdir.py

@@ -1,9 +0,0 @@
-from __future__ import annotations
-
-from wexample_wex_addon_app.workdir.code_base_workdir import CodeBaseWorkdir
-
-
-class JavascriptWorkdir(CodeBaseWorkdir):
-    def get_dependencies(self) -> list[str]:
-        # TODO search in package.json
-        return []