@mateoserrano/simple-config 1.0.0 → 1.1.1

package/README.md

@@ -1,9 +1,9 @@
-# Typescript Utilities
-
-### Development dependencies
-
-1. Typescript
-2. ESLint
-3. Prettier
-4. lint-staged
-5. Husky
+# Typescript Utilities
+
+### Development dependencies
+
+1. Typescript
+2. ESLint
+3. Prettier
+4. lint-staged
+5. Husky

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mateoserrano/simple-config",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "type": "module",
   "private": false,
   "description": "Initialize ESLint, Prettier, Husky and lint-staged for modern TypeScript projects",
@@ -14,12 +14,28 @@
   ],
   "files": [
     "scripts/",
-    "templates/"
+    "templates/",
+    "src/**"
   ],
   "bin": {
     "dev-config": "./scripts/init.js"
   },
   "engines": {
     "node": ">=20"
+  },
+  "devDependencies": {
+    "@eslint/js": "9.39.1",
+    "@types/node": "25.0.3",
+    "eslint": "9.39.1",
+    "eslint-config-prettier": "10.1.8",
+    "globals": "17.0.0",
+    "husky": "9.1.7",
+    "lint-staged": "16.2.7",
+    "prettier": "3.6.2",
+    "tsx": "4.20.6",
+    "typescript-eslint": "8.46.4"
+  },
+  "scripts": {
+    "prepare": "husky"
   }
 }

package/scripts/init.js

@@ -1,128 +1,13 @@
-#!/usr/bin/env node
-
-import { execSync } from 'node:child_process'
-import { cpSync, existsSync, mkdirSync } from 'node:fs'
-import { basename, join } from 'node:path'
-import { fileURLToPath } from 'node:url';
-
-// Dependencies
-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',
-  },
-};
-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: '.',
-    },
-  ],
-};
-
-function copyFileToFolderOrSkip(sourceFile, targetFolder) {
-  const sourceFileName = basename(sourceFile);
-  if (!existsSync(sourceFile)) {
-    console.error(`Source file not found: ${sourceFile}`);
-    return;
-  }
-
-  if (existsSync(join(targetFolder, sourceFileName))) {
-    console.log(`File ${sourceFileName} already exists in ${targetFolder}. Skipping...`);
-    return;
-  }
-  if (!existsSync(targetFolder)) {
-    console.log(`Creating folder ${targetFolder}...`);
-    mkdirSync(targetFolder, { recursive: true });
-  }
-
-  const destinationPath = join(targetFolder, sourceFileName);
-  cpSync(sourceFile, destinationPath);
-}
-
-let installNames = [];
-for (const dep of Object.values(devDeps)) {
-  installNames.push(`${dep.package}@${dep.version}`);
-}
-
-const installCmd = `npm install -D ${installNames.join(' ')}`;
-const installHuskyCmd =  'npx husky install';
-const setupHuskyCmd = 'npx husky add .husky/pre-commit "npx lint-staged"';
-
-const runSilent = cmd => execSync(cmd, { stdio: 'ignore' });
-const cwd = process.cwd();
-
-if (!existsSync(join(cwd, 'package.json'))) {
-  console.error('No package.json found.');
-  process.exit(1);
-}
-
-const repositoryDirname = fileURLToPath(new URL('.', import.meta.url));
-const templatesFolder = join(repositoryDirname, '../templates');
-
-// Install dependencies
-console.log('Installing dependencies...');
-runSilent(installCmd);
-
-// Husky
-console.log('Configuring Husky...');
-runSilent(installHuskyCmd);
-runSilent(setupHuskyCmd);
-
-// Copy files
-for (const fileGroup of Object.values(devDepFiles)) {
-  for (const file of fileGroup) {
-    const source = join(templatesFolder, file.source);
-    const targetFolder = join(cwd, file.target);
-    copyFileToFolderOrSkip(source, targetFolder);
-  }
-}
-
-console.log('\nDependencies installed successfully.');
+#!/usr/bin/env node
+
+import {
+  assertValidNodePackage,
+  installDependencies,
+  configureHusky,
+  copyConfigurationFiles,
+} from '../src/index.js'
+
+assertValidNodePackage()
+installDependencies()
+configureHusky()
+copyConfigurationFiles()

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'

package/templates/eslint.config.js

@@ -1,16 +1,17 @@
-import js from '@eslint/js';
-import tseslint from 'typescript-eslint';
-import eslintConfigPrettier from 'eslint-config-prettier';
-
-export default tseslint.config(
-  js.configs.recommended,
-  ...tseslint.configs.recommended,
-  eslintConfigPrettier,
-  {
-    rules: {
-      '@typescript-eslint/no-unused-vars': 'warn',
-      '@typescript-eslint/no-explicit-any': 'warn',
-      'no-console': 'off',
-    },
-  }
-);
+import globals from 'globals'
+
+export default [
+  {
+    files: ['**/*.js', '**/*.ts'],
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        ...globals.node,
+      },
+    },
+    rules: {
+      'no-console': 'off',
+    },
+  },
+]

package/templates/lint-staged.config.js

@@ -1,6 +1,3 @@
-export default {
-  '*.{ts,tsx,js,json}': [
-    'eslint --fix',
-    'prettier --write',
-  ],
-};
+export default {
+  '*.{ts,tsx,js,json}': ['eslint --fix', 'prettier --write'],
+}

package/templates/prettier.config.js

@@ -1,6 +1,6 @@
-export default {
-  semi: false,
-  singleQuote: true,
-  trailingComma: 'all',
-  printWidth: 100,
-};
+export default {
+  semi: false,
+  singleQuote: true,
+  trailingComma: 'all',
+  printWidth: 100,
+}

package/templates/tsconfig.json

@@ -1,15 +1,15 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "commonjs",
-    "outDir": "dist",
-    "rootDir": "src",
-    "esModuleInterop": true,
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true,
-  },
-  "include": ["src/**/*.ts"]
-}
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "outDir": "dist",
+    "rootDir": "src",
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*.ts"]
+}