@jsenv/package-publish 1.7.2 → 1.7.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/package-publish",
-  "version": "1.7.2",
+  "version": "1.7.3",
   "description": "Publish package to one or many registry.",
   "license": "MIT",
   "author": {
@@ -34,26 +34,15 @@
   ],
   "scripts": {
     "eslint": "npx eslint . --ext=.js,.mjs",
-    "importmap": "node ./script/importmap/importmap.mjs",
     "test": "node --experimental-json-modules ./script/test/test.mjs",
     "test-with-coverage": "npm run test -- --coverage",
     "prettier": "prettier --write ."
   },
   "dependencies": {
-    "@jsenv/filesystem": "2.7.1",
+    "@jsenv/filesystem": "3.1.0",
     "@jsenv/logger": "4.0.1",
     "node-fetch": "2.6.7",
     "@jsenv/log": "1.5.0",
     "semver": "7.3.5"
-  },
-  "devDependencies": {
-    "@jsenv/assert": "2.4.1",
-    "@jsenv/core": "25.3.0",
-    "@jsenv/eslint-config": "16.0.9",
-    "@jsenv/importmap-eslint-resolver": "5.2.5",
-    "@jsenv/importmap-node-module": "5.1.3",
-    "eslint": "8.7.0",
-    "eslint-plugin-import": "2.25.4",
-    "prettier": "2.5.1"
   }
 }

package/readme.md

@@ -13,8 +13,6 @@ Screenshot taken inside a github workflow when the package.json version is alrea
 
 Screenshot taken inside a github workflow when the package.json version is not published: ![publishing github workflow screenshot](./docs/publishing-github-workflow-screenshot.png)
 
-This package is using itself to be published on NPM. It is done during ["publish package" step](https://github.com/jsenv/package-publish/blob/0170a5c859c4732203ff2f3e70b85e705396ccc7/.github/workflows/main.yml#L70-L74) in GitHub worflow.
-
 # Installation
 
 ```console
@@ -31,7 +29,7 @@ _publishPackage_ is an async function publishing a package on one or many regist
 import { publishPackage } from "@jsenv/package-publish"
 
 const publishReport = await publishPackage({
-  projectDirectoryUrl: new URL('./', import.meta.url)
+  rootDirectoryUrl: new URL('./', import.meta.url)
   registriesConfig: {
     "https://registry.npmjs.org": {
       token: process.env.NPM_TOKEN,
@@ -43,9 +41,9 @@ const publishReport = await publishPackage({
 })
 ```
 
-## projectDirectoryUrl
+## rootDirectoryUrl
 
-_projectDirectoryUrl_ parameter is a string leading to a directory containing the package.json.
+_rootDirectoryUrl_ parameter is a string leading to a directory containing the package.json.
 
 This parameter is **required**.
 

package/src/internal/publish.js

@@ -4,7 +4,7 @@ import {
   urlToFileSystemPath,
   readFile,
   writeFile,
-  removeFileSystemNode,
+  removeEntry,
 } from "@jsenv/filesystem"
 import { UNICODE } from "@jsenv/log"
 
@@ -14,7 +14,7 @@ export const publish = async ({
   logger,
   packageSlug,
   logNpmPublishOutput,
-  projectDirectoryUrl,
+  rootDirectoryUrl,
   registryUrl,
   token,
 }) => {
@@ -26,37 +26,29 @@ export const publish = async ({
         process.env.NODE_AUTH_TOKEN = previousValue
       }
       process.env.NODE_AUTH_TOKEN = token
-      const projectPackageFileUrl = resolveUrl(
-        "./package.json",
-        projectDirectoryUrl,
-      )
-      const projectPackageString = await readFile(projectPackageFileUrl)
-      const restoreProjectPackageFile = () =>
-        writeFile(projectPackageFileUrl, projectPackageString)
-      const projectPackageObject = JSON.parse(projectPackageString)
-      projectPackageObject.publishConfig =
-        projectPackageObject.publishConfig || {}
-      projectPackageObject.publishConfig.registry = registryUrl
+      const rootPackageFileUrl = resolveUrl("./package.json", rootDirectoryUrl)
+      const rootPackageString = await readFile(rootPackageFileUrl)
+      const restorePackageFile = () =>
+        writeFile(rootPackageFileUrl, rootPackageString)
+      const packageObject = JSON.parse(rootPackageString)
+      packageObject.publishConfig = packageObject.publishConfig || {}
+      packageObject.publishConfig.registry = registryUrl
       promises.push(
         writeFile(
-          projectPackageFileUrl,
-          JSON.stringify(projectPackageObject, null, "  "),
+          rootPackageFileUrl,
+          JSON.stringify(packageObject, null, "  "),
         ),
       )
-      const projectNpmConfigFileUrl = resolveUrl(
-        "./.npmrc",
-        projectDirectoryUrl,
-      )
-      let restoreProjectNpmConfigFile
+      const npmConfigFileUrl = resolveUrl("./.npmrc", rootDirectoryUrl)
+      let restoreNpmConfigFile
       let projectNpmConfigString
       try {
-        projectNpmConfigString = await readFile(projectNpmConfigFileUrl)
-        restoreProjectNpmConfigFile = () =>
-          writeFile(projectNpmConfigFileUrl, projectNpmConfigString)
+        projectNpmConfigString = await readFile(npmConfigFileUrl)
+        restoreNpmConfigFile = () =>
+          writeFile(npmConfigFileUrl, projectNpmConfigString)
       } catch (e) {
         if (e.code === "ENOENT") {
-          restoreProjectNpmConfigFile = () =>
-            removeFileSystemNode(projectNpmConfigFileUrl)
+          restoreNpmConfigFile = () => removeEntry(npmConfigFileUrl)
           projectNpmConfigString = ""
         } else {
           throw e
@@ -64,10 +56,10 @@ export const publish = async ({
       }
       promises.push(
         writeFile(
-          projectNpmConfigFileUrl,
+          npmConfigFileUrl,
           setNpmConfig(projectNpmConfigString, {
             [computeRegistryTokenKey(registryUrl)]: token,
-            [computeRegistryKey(projectPackageObject.name)]: registryUrl,
+            [computeRegistryKey(packageObject.name)]: registryUrl,
           }),
         ),
       )
@@ -77,7 +69,7 @@ export const publish = async ({
           const command = exec(
             "npm publish",
             {
-              cwd: urlToFileSystemPath(projectDirectoryUrl),
+              cwd: urlToFileSystemPath(rootDirectoryUrl),
               stdio: "silent",
             },
             (error) => {
@@ -150,8 +142,8 @@ export const publish = async ({
       } finally {
         await Promise.all([
           restoreProcessEnv(),
-          restoreProjectPackageFile(),
-          restoreProjectNpmConfigFile(),
+          restorePackageFile(),
+          restoreNpmConfigFile(),
         ])
       }
     } catch (e) {

package/src/internal/readProjectPackage.js

@@ -1,10 +1,10 @@
 import { resolveUrl, urlToFileSystemPath, readFile } from "@jsenv/filesystem"
 
-export const readProjectPackage = async ({ projectDirectoryUrl }) => {
-  const packageFileUrl = resolveUrl("./package.json", projectDirectoryUrl)
+export const readProjectPackage = async ({ rootDirectoryUrl }) => {
+  const packageFileUrl = resolveUrl("./package.json", rootDirectoryUrl)
   let packageObject
   try {
-    const packageString = await readFile(packageFileUrl)
+    const packageString = await readFile(packageFileUrl, { as: "string" })
     try {
       packageObject = JSON.parse(packageString)
     } catch (e) {

package/src/publishPackage.js

@@ -15,7 +15,7 @@ import {
 
 export const publishPackage = async ({
   logLevel,
-  projectDirectoryUrl,
+  rootDirectoryUrl,
   registriesConfig,
   logNpmPublishOutput = true,
   updateProcessExitCode = true,
@@ -23,17 +23,17 @@ export const publishPackage = async ({
   const logger = createLogger({ logLevel })
   logger.debug(
     `publishPackage(${JSON.stringify(
-      { projectDirectoryUrl, logLevel, registriesConfig },
+      { rootDirectoryUrl, logLevel, registriesConfig },
       null,
       "  ",
     )})`,
   )
-  projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
+  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
   assertRegistriesConfig(registriesConfig)
 
   logger.debug(`reading project package.json`)
   const packageInProject = await readProjectPackage({
-    projectDirectoryUrl,
+    rootDirectoryUrl,
   })
 
   const { name: packageName, version: packageVersion } = packageInProject
@@ -140,7 +140,7 @@ ${actionReason.stack}`)
       logger,
       packageSlug: `${packageName}@${packageVersion}`,
       logNpmPublishOutput,
-      projectDirectoryUrl,
+      rootDirectoryUrl,
       registryUrl,
       ...registriesConfig[registryUrl],
     })