fix(example): prevent error in initial execution of generated example

Author: travi

src/project-type/package/build-details.js

@@ -1,37 +1,28 @@
-import {promises as fs} from 'fs';
+import {promises as fs} from 'node:fs';
 import deepmerge from 'deepmerge';
-import mustache from 'mustache';
 import touch from 'touch';
-import camelcase from 'camelcase';
 import {dialects, projectTypes} from '@form8ion/javascript-core';
 
 import {scaffold as scaffoldBundler} from '../publishable/bundler/index.js';
-import determinePathToTemplateFile from '../../template-path.js';
 
 const defaultBuildDirectory = 'lib';
 
-async function createExample(projectRoot, projectName, dialect) {
-  return fs.writeFile(
-    `${projectRoot}/example.js`,
-    mustache.render(
-      await fs.readFile(determinePathToTemplateFile('example.mustache'), 'utf8'),
-      {projectName: camelcase(projectName), esm: dialect === dialects.ESM}
-    )
-  );
+async function createExample(projectRoot) {
+  return fs.writeFile(`${projectRoot}/example.js`, "import {} from './lib/index.js';\n");
 }
 
-async function buildDetailsForCommonJsProject({projectRoot, projectName, provideExample}) {
+async function buildDetailsForCommonJsProject({projectRoot, provideExample}) {
   await Promise.all([
     touch(`${projectRoot}/index.js`),
     provideExample
-      ? fs.writeFile(`${projectRoot}/example.js`, `const ${camelcase(projectName)} = require('.');\n`)
+      ? fs.writeFile(`${projectRoot}/example.js`, "const {} = require('.');\n")
       : Promise.resolve()
   ]);
 
   return {};
 }
 
-export default async function ({
+export default async function buildDetails({
   projectRoot,
   projectName,
   visibility,
@@ -41,7 +32,7 @@ export default async function ({
   provideExample,
   decisions
 }) {
-  if (dialects.COMMON_JS === dialect) return buildDetailsForCommonJsProject({projectRoot, projectName, provideExample});
+  if (dialects.COMMON_JS === dialect) return buildDetailsForCommonJsProject({projectRoot, provideExample});
 
   await fs.mkdir(`${projectRoot}/src`, {recursive: true});
   const [bundlerResults] = await Promise.all([

src/project-type/package/build-details.test.js

@@ -1,47 +1,27 @@
-import {promises as fs} from 'fs';
+import {promises as fs} from 'node:fs';
 import touch from 'touch';
-import camelcase from 'camelcase';
-import mustache from 'mustache';
 import {dialects, projectTypes} from '@form8ion/javascript-core';
 
-import {afterEach, beforeEach, describe, expect, it, vi} from 'vitest';
+import {describe, expect, it, vi} from 'vitest';
 import any from '@travi/any';
 import {when} from 'jest-when';
 
-import templatePath from '../../template-path.js';
 import {scaffold as scaffoldBundler} from '../publishable/bundler/index.js';
 import buildDetails from './build-details.js';
 
-vi.mock('fs');
+vi.mock('node:fs');
 vi.mock('make-dir');
-vi.mock('camelcase');
-vi.mock('mustache');
 vi.mock('touch');
-vi.mock('../../template-path');
 vi.mock('../publishable/bundler');
 
 describe('package build details', () => {
   const projectRoot = any.string();
   const projectName = any.word();
   const pathToExample = `${projectRoot}/example.js`;
   const bundlerResults = any.simpleObject();
-  const exampleContent = any.string();
-  const pathToExampleTemplate = any.string();
-  const exampleTemplateContent = any.string();
-  const camelizedProjectName = any.word();
   const packageBundlers = any.simpleObject();
   const decisions = any.simpleObject();
 
-  beforeEach(() => {
-    when(templatePath).calledWith('example.mustache').mockReturnValue(pathToExampleTemplate);
-    when(fs.readFile).calledWith(pathToExampleTemplate, 'utf8').mockResolvedValue(exampleTemplateContent);
-    when(camelcase).calledWith(projectName).mockReturnValue(camelizedProjectName);
-  });
-
-  afterEach(() => {
-    vi.clearAllMocks();
-  });
-
   it('should correctly define a common-js project', async () => {
     const results = await buildDetails({
       dialect: dialects.COMMON_JS,
@@ -51,7 +31,7 @@ describe('package build details', () => {
     });
 
     expect(results).toEqual({});
-    expect(fs.writeFile).toHaveBeenCalledWith(pathToExample, `const ${camelizedProjectName} = require('.');\n`);
+    expect(fs.writeFile).toHaveBeenCalledWith(pathToExample, "const {} = require('.');\n");
     expect(touch).toHaveBeenCalledWith(`${projectRoot}/index.js`);
   });
 
@@ -71,9 +51,6 @@ describe('package build details', () => {
     when(scaffoldBundler)
       .calledWith({bundlers: packageBundlers, decisions, projectRoot, dialect, projectType: projectTypes.PACKAGE})
       .mockResolvedValue(bundlerResults);
-    when(mustache.render)
-      .calledWith(exampleTemplateContent, {projectName: camelizedProjectName, esm: false})
-      .mockReturnValue(exampleContent);
 
     const results = await buildDetails({
       dialect,
@@ -100,7 +77,7 @@ describe('package build details', () => {
     });
     expect(fs.mkdir).toHaveBeenCalledWith(`${projectRoot}/src`, {recursive: true});
     expect(touch).toHaveBeenCalledWith(`${projectRoot}/src/index.js`);
-    expect(fs.writeFile).toHaveBeenCalledWith(pathToExample, exampleContent);
+    expect(fs.writeFile).toHaveBeenCalledWith(pathToExample, "import {} from './lib/index.js';\n");
   });
 
   it('should not create the example file for a modern-js project when `provideExample` is `false`', async () => {

templates/example.mustache

@@ -1,3 +1 @@
-// remark-usage-ignore-next
-/* eslint-disable-next-line no-unused-vars */
-import {{ projectName }} from './lib/index.js';
+import {} from './lib/index.js';

test/integration/features/step_definitions/documentation-steps.js

@@ -1,5 +1,4 @@
-import {promises as fs} from 'fs';
-import camelcase from 'camelcase';
+import {promises as fs} from 'node:fs';
 import {fileExists} from '@form8ion/core';
 import {dialects, packageManagers, projectTypes} from '@form8ion/javascript-core';
 
@@ -19,16 +18,14 @@ export async function assertThatDocumentationIsDefinedAppropriately(
   if (projectTypes.PACKAGE === projectType && exampleShouldBeProvided && dialects.COMMON_JS === dialect) {
     const exampleContents = (await fs.readFile(pathToExampleFile)).toString();
 
-    assert.equal(exampleContents, `const ${camelcase(projectName)} = require('.');\n`);
+    assert.equal(exampleContents, "const {} = require('.');\n");
     assert.isTrue(await fileExists(`${process.cwd()}/index.js`));
     assert.isDefined(packageDetails.scripts['generate:md']);
     assert.isUndefined(packageDetails.scripts['pregenerate:md']);
   } else if (projectTypes.PACKAGE === projectType && exampleShouldBeProvided) {
     const exampleContents = (await fs.readFile(pathToExampleFile)).toString();
 
-    assert.equal(exampleContents, `// remark-usage-ignore-next
-/* eslint-disable-next-line no-unused-vars */
-import ${camelcase(projectName)} from './lib/index.js';
+    assert.equal(exampleContents, `import {} from './lib/index.js';
 `);
     assert.isTrue(await fileExists(`${projectRoot}/src/index.js`));
     assert.isDefined(packageDetails.scripts['generate:md']);