@mateoserrano/simple-config 1.1.0 → 1.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mateoserrano/simple-config",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "type": "module",
   "private": false,
   "description": "Initialize ESLint, Prettier, Husky and lint-staged for modern TypeScript projects",
@@ -14,7 +14,8 @@
   ],
   "files": [
     "scripts/",
-    "templates/"
+    "templates/",
+    "src/**"
   ],
   "bin": {
     "dev-config": "./scripts/init.js"

package/src/constants.js

@@ -0,0 +1,67 @@
+export const devDeps = {
+  tsx: {
+    package: 'tsx',
+    version: '4.20.6',
+  },
+  eslint: {
+    package: 'eslint',
+    version: '9.39.1',
+  },
+  typescriptEslint: {
+    package: 'typescript-eslint',
+    version: '8.46.4',
+  },
+  eslintJs: {
+    package: '@eslint/js',
+    version: '9.39.1',
+  },
+  prettier: {
+    package: 'prettier',
+    version: '3.6.2',
+  },
+  eslintConfigPrettier: {
+    package: 'eslint-config-prettier',
+    version: '10.1.8',
+  },
+  lintStaged: {
+    package: 'lint-staged',
+    version: '16.2.7',
+  },
+  husky: {
+    package: 'husky',
+    version: '9.1.7',
+  },
+  globals: {
+    package: 'globals',
+    version: '17.0.0',
+  }
+}
+export const devDepFiles = {
+  eslint: [
+    {
+      source: 'eslint.config.js',
+      target: '.',
+    },
+  ],
+  prettier: [
+    {
+      source: 'prettier.config.js',
+      target: '.',
+    },
+  ],
+  lintStaged: [
+    {
+      source: 'lint-staged.config.js',
+      target: '.',
+    },
+  ],
+  typescript: [
+    {
+      source: 'tsconfig.json',
+      target: '.',
+    },
+  ],
+}
+export const addHuskyPrepare = 'npm pkg set scripts.prepare="husky"'
+export const installCmd = (installNames) => `npm install -D ${installNames.join(' ')} --save-exact`
+export const setupHuskyCommand = 'npx husky add .husky/pre-commit "npx lint-staged"'

package/src/core/commands.js

@@ -0,0 +1,4 @@
+import { execSync } from 'node:child_process'
+
+export const runCommand = (command) => execSync(command, { stdio: 'inherit' })
+export const runCommandSilent = (command) => execSync(command, { stdio: 'ignore' })

package/src/core/deps.js

@@ -0,0 +1,19 @@
+import { getRemoteUrl, moveFromPath } from './utils/index.js'
+import { copyFileToFolderOrSkip } from './files.js'
+
+export const getTemplatesFolder = (templatesRelativePath) => {
+  const repositoryDirname = getRemoteUrl()
+  return moveFromPath(repositoryDirname, templatesRelativePath)
+}
+export const getInstallNames = (devDeps) =>
+  Object.values(devDeps).map((dep) => `${dep.package}@${dep.version}`)
+export const copyFilesToTargetOrSkip = (devDepFiles, templatesDirectory) => {
+  const cwd = process.cwd()
+  Object.values(devDepFiles).forEach((group) =>
+    group.forEach((file) => {
+      const source = moveFromPath(templatesDirectory, file.source)
+      const targetFolder = moveFromPath(cwd, file.target)
+      copyFileToFolderOrSkip(source, targetFolder)
+    }),
+  )
+}

package/src/core/files.js

@@ -0,0 +1,24 @@
+import { basename } from 'node:path'
+import { cpSync } from 'node:fs'
+import { createFolder, verifyValidFile, verifyValidDirectory, moveFromPath } from './utils/index.js'
+
+export const verifyNodePackage = () => verifyValidFile(moveFromPath(process.cwd(), 'package.json'))
+export function copyFileToFolderOrSkip(sourceFile, targetDirectory) {
+  const sourceFileName = basename(sourceFile)
+  const outputFileName = moveFromPath(targetDirectory, sourceFileName)
+
+  if (!verifyValidFile(sourceFile)) {
+    console.error(`File does not exist: ${sourceFile}`)
+    return
+  }
+  if (!verifyValidDirectory(targetDirectory)) {
+    console.log(`Creating folder ${targetDirectory}...`)
+    createFolder(targetDirectory)
+  }
+  if (verifyValidFile(outputFileName)) {
+    console.log(`File ${sourceFileName} already exists in ${targetDirectory}. Skipping...`)
+    return
+  }
+  const destinationPath = moveFromPath(targetDirectory, sourceFileName)
+  cpSync(sourceFile, destinationPath)
+}

package/src/core/index.js

@@ -0,0 +1,3 @@
+export * from './commands.js'
+export * from './deps.js'
+export * from './files.js'

package/src/core/utils/files.js

@@ -0,0 +1,7 @@
+import { join } from 'node:path'
+import { existsSync, mkdirSync } from 'node:fs'
+
+export const createFolder = (dirname) => mkdirSync(dirname, { recursive: true })
+export const verifyValidFile = (filePath) => existsSync(filePath)
+export const verifyValidDirectory = (directory) => existsSync(directory)
+export const moveFromPath = (directory, filename) => join(directory, filename)

package/src/core/utils/index.js

@@ -0,0 +1,2 @@
+export * from './files.js'
+export * from './urls.js'

package/src/core/utils/urls.js

@@ -0,0 +1,5 @@
+import { fileURLToPath } from 'node:url'
+
+export function getRemoteUrl() {
+  return fileURLToPath(new URL('.', import.meta.url))
+}

package/src/functions.js

@@ -0,0 +1,43 @@
+import {
+  copyFilesToTargetOrSkip,
+  getInstallNames,
+  getTemplatesFolder,
+  runCommand,
+  runCommandSilent,
+  verifyNodePackage,
+} from './core/index.js'
+import {
+  addHuskyPrepare,
+  devDepFiles,
+  devDeps,
+  installCmd,
+  setupHuskyCommand,
+} from './constants.js'
+
+const runAddPrepareCommand = () => runCommandSilent(addHuskyPrepare)
+const runInstallCommand = (installNames) => runCommandSilent(installCmd(installNames))
+const runHuskyCommand = () => {
+  runCommand(setupHuskyCommand)
+}
+const getInstallationArguments = () => getInstallNames(devDeps)
+
+export const assertValidNodePackage = () => {
+  if (!verifyNodePackage()) {
+    console.error('Error: package.json not found.')
+    process.exit(1)
+  }
+}
+export const installDependencies = () => {
+  console.log('Installing dependencies...')
+  runAddPrepareCommand()
+  runInstallCommand(getInstallationArguments())
+}
+export const configureHusky = () => {
+  console.log('Configuring Husky...')
+  runHuskyCommand()
+}
+export const copyConfigurationFiles = () => {
+  console.log('Copying configuration files...')
+  const templatesDirectory = getTemplatesFolder('../templates')
+  copyFilesToTargetOrSkip(devDepFiles, templatesDirectory)
+}

package/src/index.js

@@ -0,0 +1 @@
+export * from './functions.js'