feat/fix: Remove version requirement from package.json

pantsbuild · May 6, 2023 · 882b004 · 882b004
1 parent ad0c470
commit 882b004
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/src/python/pants/backend/javascript/package/rules.py b/src/python/pants/backend/javascript/package/rules.py
@@ -20,6 +20,7 @@
     NodeBuildScriptSourcesField,
     NodePackageNameField,
     NodePackageVersionField,
+    NPMDistributionTarget,
     PackageJsonSourceField,
 )
 from pants.core.goals.package import (
@@ -65,6 +66,10 @@ async def pack_node_package_into_tgz_for_publication(
     node_package = installation.project_env.ensure_target()
     name = node_package.get(NodePackageNameField).value
     version = node_package.get(NodePackageVersionField).value
+    if version is None:
+        raise ValueError(
+            f"{field_set.source.file_path}#version must be set in order to package a {NPMDistributionTarget.alias}."
+        )
     archive_file = f"{name}-{version}.tgz"
     result = await Get(
         ProcessResult,

diff --git a/src/python/pants/backend/javascript/package_json.py b/src/python/pants/backend/javascript/package_json.py
@@ -250,8 +250,8 @@ class NodePackageVersionField(StringField):
         This field should not be overridden; use the value from target generation.
         """
     )
-    required = True
-    value: str
+    required = False
+    value: str | None
 
 
 class NodeThirdPartyPackageVersionField(NodePackageVersionField):
@@ -531,7 +531,7 @@ def from_package_json(cls, pkg_json: PackageJson) -> PackageJsonScripts:
 class PackageJson:
     content: FrozenDict[str, Any]
     name: str
-    version: str
+    version: str | None
     snapshot: Snapshot
     workspaces: tuple[str, ...] = ()
     module: Literal["commonjs", "module"] | None = None
@@ -630,7 +630,7 @@ async def parse_package_json(content: FileContent) -> PackageJson:
     return PackageJson(
         content=parsed_package_json,
         name=parsed_package_json["name"],
-        version=parsed_package_json["version"],
+        version=parsed_package_json.get("version"),
         snapshot=await Get(Snapshot, PathGlobs([content.path])),
         module=parsed_package_json.get("type"),
         workspaces=tuple(parsed_package_json.get("workspaces", ())),