Init :: Sanitize name and paths

package.json

@@ -60,6 +60,7 @@
     "cytoscape": "^3.15.2",
     "express": "^4.18.1",
     "globby": "^11.0.4",
+    "lodash": "^4.17.21",
     "loglevel": "^1.8.1",
     "p5": "^1.8.0",
     "pkg": "^5.8.1",
@@ -76,6 +77,7 @@
     "@types/cli-box": "^6.0.4",
     "@types/cytoscape": "^3.19.7",
     "@types/express": "^4.17.20",
+    "@types/lodash": "^4.17.9",
     "@types/mocha": "^10.0.7",
     "@types/node": "^18.14.5",
     "@types/p5": "^1.7.1",
@@ -94,4 +96,4 @@
     "ts-node": "10.9.1",
     "typescript": "~5.5.1"
   }
-}
+}

src/commands/init.ts

@@ -3,8 +3,9 @@ import logger from 'loglevel'
 import { existsSync, writeFileSync } from 'node:fs'
 import { basename, join } from 'node:path'
 import { userInfo } from 'os'
-import { ENTER, createFolderIfNotExists } from '../utils'
+import { ENTER, createFolderIfNotExists, sanitizeName } from '../utils'
 import { PROGRAM_FILE_EXTENSION, TEST_FILE_EXTENSION, WOLLOK_FILE_EXTENSION } from 'wollok-ts'
+import kebabCase from 'lodash/kebabCase'
 import { execSync } from 'node:child_process'
 
 export type Options = {
@@ -35,24 +36,27 @@ export default function (folder: string | undefined, { project: _project, name,
   }
 
   // Creating files
-  const exampleName = name ?? 'example'
-  logger.info(`Creating definition file ${exampleName}.${WOLLOK_FILE_EXTENSION}`)
-  writeFileSync(join(project, `${exampleName}.${WOLLOK_FILE_EXTENSION}`), wlkDefinition)
+  const exampleName = name && name.length > 0 ? name : 'example'
+  const exampleFilename = sanitizeName(exampleName)
+
+  const wollokDefinitionFile = `${exampleFilename}.${WOLLOK_FILE_EXTENSION}`
+  logger.info(`Creating definition file ${wollokDefinitionFile}`)
+  writeFileSync(join(project, wollokDefinitionFile), wlkDefinition)
 
   if (!noTest) {
-    const testFile = `test${capitalizeFirstLetter(exampleName)}.${TEST_FILE_EXTENSION}`
+    const testFile = `test${capitalizeFirstLetter(exampleFilename)}.${TEST_FILE_EXTENSION}`
     logger.info(`Creating test file ${testFile}`)
-    writeFileSync(join(project, testFile), testDefinition(exampleName))
+    writeFileSync(join(project, testFile), testDefinition(exampleFilename))
   }
 
   if (game) {
-    const gameFile = `main${capitalizeFirstLetter(exampleName)}.${PROGRAM_FILE_EXTENSION}`
+    const gameFile = `main${capitalizeFirstLetter(exampleFilename)}.${PROGRAM_FILE_EXTENSION}`
     logger.info(`Creating program file ${gameFile}`)
-    writeFileSync(join(project, `${gameFile}`), gameDefinition(exampleName))
+    writeFileSync(join(project, gameFile), gameDefinition(exampleFilename))
   }
 
   logger.info('Creating package.json')
-  writeFileSync(join(project, 'package.json'), packageJsonDefinition(project, game))
+  writeFileSync(join(project, 'package.json'), packageJsonDefinition(name ?? project, game))
 
   if (!noCI) {
     logger.info('Creating CI files')
@@ -75,7 +79,7 @@ export default function (folder: string | undefined, { project: _project, name,
   }
 
   // Finish
-  logger.info(green('✨ Project succesfully created. Happy coding!'))
+  logger.info(green('✨ Project successfully created. Happy coding!'))
 }
 
 
@@ -131,7 +135,7 @@ program PepitaGame {
 `
 
 const packageJsonDefinition = (projectName: string, game: boolean) => `{
-  "name": "${basename(projectName)}",
+  "name": "${kebabCase(basename(projectName))}",
   "version": "1.0.0",
   ${game ? assetsConfiguration() : ''}"wollokVersion": "4.0.0",
   "author": "${userInfo().username}",

src/utils.ts

@@ -4,6 +4,7 @@
 import globby from 'globby'
 import logger from 'loglevel'
 import path, { join } from 'path'
+import camelCase from 'lodash/camelCase'
 import { getDataDiagram, VALID_IMAGE_EXTENSIONS, VALID_SOUND_EXTENSIONS } from 'wollok-web-tools'
 import { buildEnvironment, Environment, getDynamicDiagramData, Interpreter, Package, Problem, validate, WOLLOK_EXTRA_STACK_TRACE_HEADER, WollokException } from 'wollok-ts'
 import { ElementDefinition } from 'cytoscape'
@@ -173,11 +174,22 @@
   process.exit(13)
 }
 
+// ══════════════════════════════════════════════════════════════════════════════════════════════════════════════════
+// SANITIZING
+// ══════════════════════════════════════════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Sanitizes project name to allow it to be used as a filename and as a module name.
+ * If it doesn't start with a lowercase letter or a '_', it adds '_' at the beggining.
+ * Replaces every symbol not allowed with a '_'.
+ */
+export const sanitizeName = (name: string): string => camelCase(name[0].replace(/([^a-z_])/g, '_$1') + name.slice(1).replace(/[^a-zA-z1-9_-]/g, '_'))
+
 // ══════════════════════════════════════════════════════════════════════════════════════════════════════════════════
 // DYNAMIC DIAGRAM
 // ══════════════════════════════════════════════════════════════════════════════════════════════════════════════════
 
 export function getDynamicDiagram(interpreter: Interpreter, rootFQN?: Package): ElementDefinition[] {
   const objects = getDynamicDiagramData(interpreter, rootFQN)
   return getDataDiagram(objects)
-}
+}

test/assertions.ts

@@ -1,5 +1,5 @@
 import { ElementDefinition } from 'cytoscape'
-import { existsSync } from 'fs'
+import { existsSync, lstatSync, readdirSync } from 'fs'
 
 type ElementDefinitionQuery = Partial<ElementDefinition['data']>
 

test/init.test.ts

@@ -108,6 +108,22 @@ describe('testing init', () => {
     expect(join(customFolderProject, '.gitignore')).to.pathExists()
   })
 
+
+  it('should normalize package.json name when creating with custom name', async () => {
+    init(undefined, { ...baseOptions, name: 'Pepita Game' })
+
+    expect(join(project, 'pepitaGame.wlk')).to.pathExists()
+    expect(join(project, 'testPepitaGame.wtest')).to.pathExists()
+    expect(join(project, 'package.json')).to.pathExists()
+    expect(join(project, GITHUB_FOLDER, 'ci.yml')).to.pathExists()
+    expect(join(project, 'README.md')).to.pathExists()
+    expect(join(project, '.gitignore')).to.pathExists()
+    // Assert content of package.json
+    const packageJson = readFileSync(join(project, 'package.json'), 'utf8')
+    const { name } = JSON.parse(packageJson)
+    expect(name).to.be.equal('pepita-game')
+  })
+
   it('should skip the initialization of a git repository if notGit flag es enabled', async () => {
     init(undefined, { ...baseOptions, noGit: true })
 
@@ -119,6 +135,42 @@ describe('testing init', () => {
     expect(join(project, GITHUB_FOLDER, 'ci.yml')).to.pathExists()
     expect(join(project, 'README.md')).to.pathExists()
     expect(join(project, '.gitignore')).to.pathExists()
+  })
+
+  it('should normalize imports and filenames', async () => {
+    init(undefined, { ...baseOptions, name: 'Pepita Game', game: true })
+
+    const wollokDefinitionFile = join(project, 'pepitaGame.wlk')
+    const wollokMainFile = join(project, 'mainPepitaGame.wpgm')
+    const wollokTestFile = join(project, 'testPepitaGame.wtest')
+
+    expect(wollokDefinitionFile).to.pathExists()
+    expect(wollokMainFile).to.pathExists()
+    expect(wollokTestFile).to.pathExists()
+
+    // Assert content of files
+    const mainFileContent = readFileSync(wollokMainFile, 'utf8')
+    expect(mainFileContent).to.include('import pepitaGame.pepita')
+    const testFileContent = readFileSync(wollokTestFile, 'utf8')
+    expect(testFileContent).to.include('import pepitaGame.pepita')
+  })
+
+  it('should sanitize especial characters', async () => {
+    init(undefined, { ...baseOptions, name: 'Some random Game :) !', game: true })
+
+    const wollokDefinitionFile = join(project, 'someRandomGame.wlk')
+    const wollokMainFile = join(project, 'mainSomeRandomGame.wpgm')
+    const wollokTestFile = join(project, 'testSomeRandomGame.wtest')
+
+    expect(wollokDefinitionFile).to.pathExists()
+    expect(wollokMainFile).to.pathExists()
+    expect(wollokTestFile).to.pathExists()
+
+    // Assert content of files
+    const mainFileContent = readFileSync(wollokMainFile, 'utf8')
+    expect(mainFileContent).to.include('import someRandomGame.pepita')
+    const testFileContent = readFileSync(wollokTestFile, 'utf8')
+    expect(testFileContent).to.include('import someRandomGame.pepita')
     expect(getResourceFolder()).to.be.undefined
   })