@form8ion/javascript 16.0.0-beta.1 → 16.0.0-beta.3

package/package.json

@@ -2,7 +2,7 @@
   "name": "@form8ion/javascript",
   "description": "JavaScript language plugin for the @form8ion toolset",
   "license": "MIT",
-  "version": "16.0.0-beta.1",
+  "version": "16.0.0-beta.3",
   "type": "module",
   "engines": {
     "node": "^22.21.0 || >=24.12"
@@ -59,7 +59,7 @@
     "access": "public",
     "provenance": true
   },
-  "packageManager": "npm@11.15.0+sha512.fa4d2d93b9519e93143e70bb913b94ff2ad5fe69c5a0f84943be557cbb59e9fc1bcce55768fb1313f225f4f9f50c78b8f366f2332aa41effd7b10efa98d8d72f",
+  "packageManager": "npm@11.16.0+sha512.03be172fc3b199c7a06433163e459be5b110a6983c1dd6305b7ac10f6b0fa12e1440755a8df6b1064ab2ccb789df0474919fb9c684e322dc57685ede21752ccb",
   "dependencies": {
     "@form8ion/c8": "^1.0.0-beta.2",
     "@form8ion/codecov": "^7.0.0-beta.1",
@@ -68,7 +68,7 @@
     "@form8ion/core": "^5.0.0-beta.9",
     "@form8ion/eslint": "^7.0.0-beta.1",
     "@form8ion/husky": "^7.0.0-beta.1",
-    "@form8ion/javascript-core": "^12.0.0-beta.1",
+    "@form8ion/javascript-core": "^13.0.0",
     "@form8ion/overridable-prompts": "^1.2.0",
     "@form8ion/prettier": "^3.0.0",
     "@hapi/hoek": "^11.0.0",
@@ -86,23 +86,23 @@
   },
   "devDependencies": {
     "@cucumber/cucumber": "12.9.0",
-    "@form8ion/commitlint-config": "2.0.15",
+    "@form8ion/commitlint-config": "2.0.16",
     "@form8ion/eslint-config": "7.1.0-beta.1",
     "@form8ion/eslint-config-cucumber": "1.4.1",
     "@form8ion/eslint-config-vitest": "1.1.0",
     "@form8ion/remark-lint-preset": "6.0.7",
     "@rollup/plugin-node-resolve": "16.0.3",
     "@travi/any": "3.3.0",
-    "@vitest/coverage-v8": "4.1.7",
+    "@vitest/coverage-v8": "4.1.8",
     "ban-sensitive-files": "1.10.11",
     "chai": "6.2.2",
     "cz-conventional-changelog": "3.3.0",
     "debug": "4.4.3",
     "gplint": "2.5.2",
     "husky": "9.1.7",
-    "js-yaml": "4.1.1",
+    "js-yaml": "4.2.0",
     "lockfile-lint": "5.0.0",
-    "ls-engines": "0.9.4",
+    "ls-engines": "0.10.0",
     "mock-fs": "5.5.0",
     "npm-run-all2": "9.0.1",
     "publint": "0.3.21",
@@ -110,10 +110,10 @@
     "remark-toc": "9.0.0",
     "remark-usage": "11.0.1",
     "rimraf": "6.1.3",
-    "rollup": "4.60.4",
+    "rollup": "4.61.1",
     "rollup-plugin-auto-external": "2.0.0",
     "testdouble": "3.20.2",
-    "vitest": "4.1.7",
+    "vitest": "4.1.8",
     "vitest-when": "0.10.0"
   }
 }

package/src/npm-config/index.js

@@ -1,5 +1,3 @@
 export {default as scaffold} from './scaffolder.js';
 export {default as test} from './tester.js';
 export {default as lift} from './lifter.js';
-export {default as read} from './reader.js';
-export {default as write} from './writer.js';

package/src/npm-config/lifter.js

@@ -1,14 +1,13 @@
-import read from './reader.js';
-import write from './writer.js';
+import {loadNpmrc, writeNpmrc} from '@form8ion/javascript-core';
 
 export default async function liftNpmConfig({projectRoot}) {
   const {
     provenance,
     'engines-strict': enginesStrict,
     ...remainingProperties
-  } = await read({projectRoot});
+  } = await loadNpmrc({projectRoot});
 
-  await write({projectRoot, config: remainingProperties});
+  await writeNpmrc({projectRoot, config: remainingProperties});
 
   return {};
 }

package/src/npm-config/lifter.test.js

@@ -1,23 +1,22 @@
+import {loadNpmrc, writeNpmrc} from '@form8ion/javascript-core';
+
 import {describe, expect, it, vi} from 'vitest';
 import any from '@travi/any';
 import {when} from 'vitest-when';
 
-import read from './reader.js';
-import write from './writer.js';
 import liftNpmConfig from './lifter.js';
 
-vi.mock('./reader.js');
-vi.mock('./writer.js');
+vi.mock('@form8ion/javascript-core');
 
 describe('npm config lifter', () => {
   it('should remove `provenance` and `engines-strict` properties from the config', async () => {
     const projectRoot = any.string();
     const desiredProperties = any.simpleObject();
-    when(read)
+    when(loadNpmrc)
       .calledWith({projectRoot})
       .thenResolve({...desiredProperties, provenance: true, 'engines-strict': true});
 
     expect(await liftNpmConfig({projectRoot})).toEqual({});
-    expect(write).toHaveBeenCalledWith({projectRoot, config: desiredProperties});
+    expect(writeNpmrc).toHaveBeenCalledWith({projectRoot, config: desiredProperties});
   });
 });

package/src/npm-config/scaffolder.js

@@ -1,13 +1,11 @@
-import {projectTypes} from '@form8ion/javascript-core';
-
-import write from './writer.js';
+import {projectTypes, writeNpmrc} from '@form8ion/javascript-core';
 
 function projectWillNotBeConsumed(projectType) {
   return projectTypes.APPLICATION === projectType || projectTypes.CLI === projectType;
 }
 
 export default async function scaffoldNpmConfiguration({projectRoot, projectType}) {
-  await write({
+  await writeNpmrc({
     projectRoot,
     config: {'update-notifier': false, ...projectWillNotBeConsumed(projectType) && {'save-exact': true}}
   });

package/src/npm-config/scaffolder.test.js

@@ -1,25 +1,20 @@
-import {projectTypes} from '@form8ion/javascript-core';
+import {projectTypes, writeNpmrc} from '@form8ion/javascript-core';
 
-import {describe, vi, it, expect, afterEach} from 'vitest';
+import {describe, expect, it, vi} from 'vitest';
 import any from '@travi/any';
 
-import write from './writer.js';
 import scaffoldNpmConfig from './scaffolder.js';
 
 vi.mock('node:fs');
-vi.mock('./writer.js');
+vi.mock('@form8ion/javascript-core');
 
 describe('npm config scaffolder', () => {
   const projectRoot = any.string();
 
-  afterEach(() => {
-    vi.clearAllMocks();
-  });
-
   it('should save exact versions of dependencies for applications', async () => {
     await scaffoldNpmConfig({projectRoot, projectType: projectTypes.APPLICATION});
 
-    expect(write).toHaveBeenCalledWith({
+    expect(writeNpmrc).toHaveBeenCalledWith({
       projectRoot,
       config: {
         'update-notifier': false,
@@ -31,7 +26,7 @@ describe('npm config scaffolder', () => {
   it('should save exact versions of dependencies for cli applications', async () => {
     await scaffoldNpmConfig({projectRoot, projectType: projectTypes.CLI});
 
-    expect(write).toHaveBeenCalledWith({
+    expect(writeNpmrc).toHaveBeenCalledWith({
       projectRoot,
       config: {
         'update-notifier': false,
@@ -43,7 +38,7 @@ describe('npm config scaffolder', () => {
   it('should allow semver ranges for dependencies of packages', async () => {
     await scaffoldNpmConfig({projectRoot, projectType: projectTypes.PACKAGE});
 
-    expect(write).toHaveBeenCalledWith({projectRoot, config: {'update-notifier': false}});
+    expect(writeNpmrc).toHaveBeenCalledWith({projectRoot, config: {'update-notifier': false}});
   });
 
   it('should define the script to enforce peer-dependency compatibility', async () => {

package/src/options/schemas.test.js

@@ -122,7 +122,7 @@ describe('options schemas', () => {
       expect(validateOptions(visibilitySchema, visibility)).toEqual(visibility);
     });
 
-    it('should consider values other than `Public` and `Private` as invalid', () => {
+    it('should consider values other than `OSS`, `ISS` and `CS` as invalid', () => {
       expect(() => validateOptions(visibilitySchema, any.word()))
         .toThrowError('"value" must be one of [OSS, ISS, CS]');
     });

package/src/options/validator.js

@@ -38,7 +38,8 @@ export function validate(options) {
       packageTypes: pluginsSchema,
       monorepoTypes: pluginsSchema,
       hosts: pluginsSchema,
-      ciServices: pluginsSchema
+      ciServices: pluginsSchema,
+      registries: pluginsSchema
     }
   }).required();
 

package/src/options/validator.test.js

@@ -68,7 +68,8 @@ describe('options validator', () => {
           packageTypes: pluginsSchema,
           monorepoTypes: pluginsSchema,
           hosts: pluginsSchema,
-          ciServices: pluginsSchema
+          ciServices: pluginsSchema,
+          registries: pluginsSchema
         }
       })
       .thenReturn({required: joiRequiredObject});

package/src/project-type/publishable/access-level.test.js

@@ -8,7 +8,7 @@ describe('package access level', () => {
     expect(determinePackageAccessLevelFromProjectVisibility({projectVisibility: 'OSS'})).toEqual('public');
   });
 
-  it('should return `restricted` when the project visibility is `Private`', () => {
+  it('should return `restricted` when the project visibility is `ISS` or `CS`', () => {
     expect(determinePackageAccessLevelFromProjectVisibility({projectVisibility: any.fromList(['ISS', 'CS'])}))
       .toEqual('restricted');
   });

package/src/prompts/conditionals.js

@@ -16,7 +16,7 @@ export function projectIsApplication(answers) {
 }
 
 function packageShouldBeScoped(visibility, answers) {
-  return 'Private' === visibility || answers[questionNames.SHOULD_BE_SCOPED];
+  return ['ISS', 'CS'].includes(visibility) || answers[questionNames.SHOULD_BE_SCOPED];
 }
 
 function willBePublishedToNpm(answers) {

package/src/prompts/conditionals.test.js

@@ -33,8 +33,15 @@ describe('javascript prompt conditionals', () => {
       })).toBe(true);
     });
 
-    it('should present a scope prompt when a package is private, because they must be scoped', () => {
-      expect(scopePromptShouldBePresentedFactory('Private')({
+    it('should present a scope prompt when a package is inner source, because they must be scoped', () => {
+      expect(scopePromptShouldBePresentedFactory('ISS')({
+        [questionNames.SHOULD_BE_SCOPED]: false,
+        [questionNames.PROJECT_TYPE]: projectTypes.PACKAGE
+      })).toBe(true);
+    });
+
+    it('should present a scope prompt when a package is closed source, because they must be scoped', () => {
+      expect(scopePromptShouldBePresentedFactory('CS')({
         [questionNames.SHOULD_BE_SCOPED]: false,
         [questionNames.PROJECT_TYPE]: projectTypes.PACKAGE
       })).toBe(true);
@@ -47,15 +54,29 @@ describe('javascript prompt conditionals', () => {
       })).toBe(true);
     });
 
-    it('should present a scope prompt when a CLI is private, because they must be scoped', () => {
-      expect(scopePromptShouldBePresentedFactory('Private')({
+    it('should present a scope prompt when a CLI is closed source, because they must be scoped', () => {
+      expect(scopePromptShouldBePresentedFactory('CS')({
         [questionNames.SHOULD_BE_SCOPED]: false,
         [questionNames.PROJECT_TYPE]: projectTypes.CLI
       })).toBe(true);
     });
 
-    it('should not present a scope prompt when an application is private', () => {
-      expect(scopePromptShouldBePresentedFactory('Private')({
+    it('should present a scope prompt when a CLI is inner source, because they must be scoped', () => {
+      expect(scopePromptShouldBePresentedFactory('ISS')({
+        [questionNames.SHOULD_BE_SCOPED]: false,
+        [questionNames.PROJECT_TYPE]: projectTypes.CLI
+      })).toBe(true);
+    });
+
+    it('should not present a scope prompt when an application is closed source', () => {
+      expect(scopePromptShouldBePresentedFactory('CS')({
+        [questionNames.SHOULD_BE_SCOPED]: false,
+        [questionNames.PROJECT_TYPE]: projectTypes.APPLICATION
+      })).toBe(false);
+    });
+
+    it('should not present a scope prompt when an application is inner source', () => {
+      expect(scopePromptShouldBePresentedFactory('ISS')({
         [questionNames.SHOULD_BE_SCOPED]: false,
         [questionNames.PROJECT_TYPE]: projectTypes.APPLICATION
       })).toBe(false);

package/src/prompts/questions.js

@@ -101,7 +101,7 @@ export async function prompt(
       choices: [...Object.values(projectTypes), 'Other'],
       default: projectTypes.PACKAGE
     },
-    ...'Private' === visibility ? [] : [{
+    ...['ISS', 'CS'].includes(visibility) ? [] : [{
       name: questionNames.SHOULD_BE_SCOPED,
       message: 'Should this package be scoped?',
       type: 'confirm',

package/src/prompts/questions.test.js

@@ -212,13 +212,13 @@ describe('prompts', () => {
       .thenReturn(commonQuestions);
     prompts.prompt.mockResolvedValue(answers);
 
-    await prompt(ciServices, {}, 'Private', vcs, null, null, pathWithinParent, {logger});
+    await prompt(ciServices, {}, 'CS', vcs, null, null, pathWithinParent, {logger});
 
     const [questions] = prompts.prompt.mock.lastCall;
     expect(questions.filter(question => questionNames.NODE_VERSION_CATEGORY === question.name).length).toEqual(0);
   });
 
-  it('should not ask whether private packages should be scoped', async () => {
+  it('should not ask whether closed source packages should be scoped', async () => {
     when(execa).calledWith('npm', ['whoami']).thenResolve({stdout: any.word()});
     npmConfFactory.mockReturnValue({get: () => undefined});
     when(commonPrompts.questions)
@@ -226,7 +226,21 @@ describe('prompts', () => {
       .thenReturn(commonQuestions);
     prompts.prompt.mockResolvedValue(answers);
 
-    await prompt(ciServices, {}, 'Private', vcs, null, null, pathWithinParent, {logger});
+    await prompt(ciServices, {}, 'CS', vcs, null, null, pathWithinParent, {logger});
+
+    const [questions] = prompts.prompt.mock.lastCall;
+    expect(questions.filter(question => questionNames.SHOULD_BE_SCOPED === question.name).length).toEqual(0);
+  });
+
+  it('should not ask whether inner source packages should be scoped', async () => {
+    when(execa).calledWith('npm', ['whoami']).thenResolve({stdout: any.word()});
+    npmConfFactory.mockReturnValue({get: () => undefined});
+    when(commonPrompts.questions)
+      .calledWith({vcs, ciServices, pathWithinParent})
+      .thenReturn(commonQuestions);
+    prompts.prompt.mockResolvedValue(answers);
+
+    await prompt(ciServices, {}, 'ISS', vcs, null, null, pathWithinParent, {logger});
 
     const [questions] = prompts.prompt.mock.lastCall;
     expect(questions.filter(question => questionNames.SHOULD_BE_SCOPED === question.name).length).toEqual(0);
@@ -240,7 +254,7 @@ describe('prompts', () => {
       .thenReturn(commonQuestions);
     prompts.prompt.mockResolvedValue(answers);
 
-    await prompt(ciServices, {}, 'Public', vcs, {}, null, pathWithinParent, {logger});
+    await prompt(ciServices, {}, 'OSS', vcs, {}, null, pathWithinParent, {logger});
 
     const [questions] = prompts.prompt.mock.lastCall;
     expect(questions.filter(question => questionNames.SHOULD_BE_SCOPED === question.name).length).toEqual(1);

package/src/prompts/validators.js

@@ -1,7 +1,12 @@
 export function scope(visibility) {
   return input => {
-    if (!input && 'Private' === visibility) {
-      return 'Private packages must be scoped (https://docs.npmjs.com/private-modules/intro#setting-up-your-package)';
+    if (!input) {
+      if ('CS' === visibility) {
+        return 'Closed source packages must be scoped';
+      }
+      if ('ISS' === visibility) {
+        return 'Inner source packages must be scoped';
+      }
     }
 
     return true;

package/src/prompts/validators.test.js

@@ -1,19 +1,22 @@
 import {expect, it, describe} from 'vitest';
+import any from '@travi/any';
 
 import {scope} from './validators.js';
 
 describe('question validators', () => {
-  it('should require a scope for private project', () => {
-    expect(scope('Private')()).toEqual(
-      'Private packages must be scoped (https://docs.npmjs.com/private-modules/intro#setting-up-your-package)'
-    );
+  it('should require a scope for a closed-source project', () => {
+    expect(scope('CS')()).toEqual('Closed source packages must be scoped');
+  });
+
+  it('should require a scope for an inner-source project', () => {
+    expect(scope('ISS')()).toEqual('Inner source packages must be scoped');
   });
 
   it('it should consider a provided value to be a valid answer to private projects', () => {
-    expect(scope('Public')()).toBe(true);
+    expect(scope('OSS')(any.word())).toBe(true);
   });
 
   it('it should consider an empty value to be a valid answer to public projects', () => {
-    expect(scope('Public')()).toBe(true);
+    expect(scope('OSS')()).toBe(true);
   });
 });

package/src/registries/lifter.js

@@ -1,20 +1,21 @@
+import {loadNpmrc, writeNpmrc} from '@form8ion/javascript-core';
+
 import {
   scaffold as scaffoldLockfileLint,
   test as lockfileLintIsAlreadyConfigured,
   read as readLockfileLintConfig,
   write as writeLockfileLintConfig
 } from '../lockfile-lint/index.js';
-import {read as readNpmConfig, write as writeNpmConfig} from '../npm-config/index.js';
 import buildRegistriesConfig from './npm-config/list-builder.js';
 import buildAllowedHostsList from '../lockfile-lint/allowed-hosts-builder.js';
 
 async function updateRegistriesInNpmConfig(registries, projectRoot) {
   const registriesForNpmConfig = buildRegistriesConfig(registries);
 
-  await writeNpmConfig({
+  await writeNpmrc({
     projectRoot,
     config: {
-      ...(await readNpmConfig({projectRoot})),
+      ...(await loadNpmrc({projectRoot})),
       ...registriesForNpmConfig
     }
   });

package/src/registries/lifter.test.js

@@ -1,3 +1,5 @@
+import {loadNpmrc, writeNpmrc} from '@form8ion/javascript-core';
+
 import any from '@travi/any';
 import {beforeEach, describe, expect, it, vi} from 'vitest';
 import {when} from 'vitest-when';
@@ -9,14 +11,13 @@ import {
   read as readLockfileLintConfig,
   write as writeLockfileLintConfig
 } from '../lockfile-lint/index.js';
-import {read as readNpmConfig, write as writeNpmConfig} from '../npm-config/index.js';
 import buildRegistriesConfig from './npm-config/list-builder.js';
 import liftRegistries from './lifter.js';
 
+vi.mock('@form8ion/javascript-core');
 vi.mock('../lockfile-lint/allowed-hosts-builder.js');
 vi.mock('../lockfile-lint/index.js');
 vi.mock('../registries/npm-config/list-builder.js');
-vi.mock('../npm-config/index.js');
 
 describe('registries lifter', () => {
   const projectRoot = any.string();
@@ -27,7 +28,7 @@ describe('registries lifter', () => {
   const existingNpmConfig = any.simpleObject();
 
   beforeEach(() => {
-    when(readNpmConfig).calledWith({projectRoot}).thenResolve(existingNpmConfig);
+    when(loadNpmrc).calledWith({projectRoot}).thenResolve(existingNpmConfig);
     when(buildRegistriesConfig).calledWith(registries).thenReturn(processedRegistryDetails);
   });
 
@@ -40,7 +41,7 @@ describe('registries lifter', () => {
 
     expect(await liftRegistries({projectRoot, packageManager, configs})).toEqual({});
 
-    expect(writeNpmConfig).toHaveBeenCalledWith({
+    expect(writeNpmrc).toHaveBeenCalledWith({
       projectRoot,
       config: {...existingNpmConfig, ...processedRegistryDetails}
     });

package/src/npm-config/reader.js

@@ -1,11 +0,0 @@
-import {parse} from 'ini';
-import {promises as fs} from 'node:fs';
-import {fileExists} from '@form8ion/core';
-
-export default async function readNpmConfig({projectRoot}) {
-  const pathToConfig = `${projectRoot}/.npmrc`;
-
-  if (!(await fileExists(pathToConfig))) return {};
-
-  return parse(await fs.readFile(pathToConfig, 'utf-8'));
-}

package/src/npm-config/reader.test.js

@@ -1,33 +0,0 @@
-import {promises as fs} from 'node:fs';
-import {stringify} from 'ini';
-import {fileExists} from '@form8ion/core';
-
-import {describe, expect, it, vi} from 'vitest';
-import {when} from 'vitest-when';
-import any from '@travi/any';
-
-import readConfig from './reader.js';
-
-vi.mock('node:fs');
-vi.mock('@form8ion/core');
-
-describe('npm config reader', () => {
-  const projectRoot = any.string();
-  const pathToConfig = `${projectRoot}/.npmrc`;
-
-  it('should read the .npmrc file', async () => {
-    const existingProperties = any.simpleObject();
-    when(fileExists).calledWith(pathToConfig).thenResolve(true);
-    when(fs.readFile)
-      .calledWith(pathToConfig, 'utf-8')
-      .thenReturn(stringify(existingProperties));
-
-    expect(await readConfig({projectRoot})).toEqual(existingProperties);
-  });
-
-  it('should return empty when the file does not exist', async () => {
-    when(fileExists).calledWith(pathToConfig).thenResolve(false);
-
-    expect(await readConfig({projectRoot})).toEqual({});
-  });
-});

package/src/npm-config/writer.js

@@ -1,6 +0,0 @@
-import {promises as fs} from 'node:fs';
-import {stringify} from 'ini';
-
-export default async function writeNpmConfig({projectRoot, config}) {
-  await fs.writeFile(`${projectRoot}/.npmrc`, stringify(config));
-}

package/src/npm-config/writer.test.js

@@ -1,24 +0,0 @@
-import {promises as fs} from 'node:fs';
-import {stringify} from 'ini';
-
-import {describe, expect, vi, it} from 'vitest';
-import any from '@travi/any';
-import {when} from 'vitest-when';
-
-import write from './writer.js';
-
-vi.mock('node:fs');
-vi.mock('ini');
-
-describe('npm config writer', () => {
-  it('should write the .npmrc file', async () => {
-    const projectRoot = any.string();
-    const config = any.simpleObject();
-    const stringifiedIniConfig = any.string();
-    when(stringify).calledWith(config).thenReturn(stringifiedIniConfig);
-
-    await write({projectRoot, config});
-
-    expect(fs.writeFile).toHaveBeenCalledWith(`${projectRoot}/.npmrc`, stringifiedIniConfig);
-  });
-});