cc/create-computercraft
1
0
Fork 0
mirror of https://github.com/MincoMK/create-computercraft.git synced 2025-12-10 06:33:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

init

Browse Source
This commit is contained in:
minco
2025-05-29 12:44:25 +09:00
commit 23b81017ec
14 changed files with 390 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
eslint.config.mjs Normal file
View File

@@ -0,0 +1,11 @@
import js from "@eslint/js";
import globals from "globals";
import tseslint from "typescript-eslint";
import { defineConfig } from "eslint/config";
export default defineConfig([
{ files: ["**/*.{js,mjs,cjs,ts,mts,cts}"], plugins: { js }, extends: ["js/recommended"] },
{ files: ["**/*.{js,mjs,cjs,ts,mts,cts}"], languageOptions: { globals: globals.browser } },
tseslint.configs.recommended,
]);

32
package.json Normal file
View File

@@ -0,0 +1,32 @@
{
"name": "create-computercraft",
"version": "1.0.0",
"description": "",
"bin": {
"create-computercraft": "dist/main.js"
},
"scripts": {
"build": "tsc",
"test": "jest"
},
"keywords": [],
"author": "",
"license": "ISC",
"packageManager": "pnpm@10.11.0",
"devDependencies": {
"@eslint/js": "^9.27.0",
"@types/jest": "^29.5.14",
"@types/node": "^22.15.24",
"@types/validate-npm-package-name": "^4.0.2",
"eslint": "^9.27.0",
"globals": "^16.2.0",
"jest": "^29.7.0",
"prettier": "3.5.3",
"typescript": "^5.8.3",
"typescript-eslint": "^8.33.0"
},
"dependencies": {
"@clack/prompts": "^0.11.0",
"validate-npm-package-name": "^6.0.0"
}
}

77
src/main.ts Normal file
View File

@@ -0,0 +1,77 @@
#!/usr/bin/env node
import { intro, log, outro, select, spinner, text } from "@clack/prompts";
import validate from "validate-npm-package-name";
import * as fs from "fs/promises";
import * as fss from "fs";
import { resolve } from "path";
import { exit } from "process";
import { exec } from "child_process";
import { info } from "console";
import { copyProject, installDeps } from "./project";
async function main() {
intro("create-computercraft");
const projectName = await text({
message: "What is your project name?",
validate(value) {
if (!validate(value))
return "Project name should satisfy NPM package name rules.";
if (fss.existsSync(value)) return "Project already exists.";
},
});
if (typeof projectName != "string") {
log.error("Project name is invalid.");
exit(1);
}
const projectType = await select({
message: "Which type of project do you need?",
options: [
{
value: "executable",
label: "Executable",
hint: "Final single lua file",
},
{ value: "library", label: "Library", hint: "NPM compatible library" },
],
});
if (typeof projectType != "string") {
log.error("Project type is invalid.");
exit(1);
}
const packageManager = await select({
message: "Which package manager would you love to?",
options: [
{ value: "npm i", label: "npm" },
{ value: "yarn add", label: "yarn" },
{ value: "pnpm i", label: "pnpm" },
{ value: "none", label: "I'd install it myself" },
],
});
if (typeof packageManager != "string") {
log.error("Package manager is invalid.");
exit(1);
}
await copyProject(projectName, projectType);
if (packageManager != "none") {
const s = spinner();
s.start("Installing dependencies...");
await installDeps(projectName, packageManager);
s.stop("Installed dependencies.");
}
info("Run build script to start.");
outro("You're all set!");
}
main();

40
src/project.ts Normal file
View File

@@ -0,0 +1,40 @@
import { log } from "@clack/prompts";
import { exec } from "child_process";
import * as fs from "fs/promises";
import { resolve } from "path";
import { exit } from "process";
export async function copyProject(projectName: string, projectType: string) {
await fs.cp(resolve(__dirname, "../templates/" + projectType), projectName, {
recursive: true,
});
const packageJsonPath = resolve(projectName, "package.json");
const packageData = await fs.readFile(packageJsonPath, "utf-8");
const packageDataFramed = packageData.replace(
`{{ PROJECT_NAME }}`,
projectName,
);
await fs.writeFile(packageJsonPath, packageDataFramed, "utf-8");
}
export async function installDeps(projectName: string, packageManager: string) {
await new Promise((rs, rj) => {
exec(
packageManager,
{ cwd: resolve(projectName) },
(err, stdout, stderr) => {
if (err) {
log.error("Error while installing package.");
log.error(stdout);
log.error(stderr);
rj();
} else rs(0);
},
);
}).catch(() => {
exit(1);
});
}

3
templates/executable/.gitignore vendored Normal file
View File

@@ -0,0 +1,3 @@
dist/**/*
node_modules
pnpm-lock.yaml

25
templates/executable/package.json Normal file
View File

@@ -0,0 +1,25 @@
{
"name": "{{ PROJECT_NAME }}",
"version": "1.0.0",
"description": "",
"license": "ISC",
"author": "",
"type": "commonjs",
"main": "index.js",
"scripts": {
"build": "tstl",
"postbuild": "node scripts/postbuild.js"
},
"devDependencies": {
"@eslint/js": "^9.27.0",
"computercraft-ts": "^1.0.0",
"eslint": "^9.27.0",
"globals": "^16.2.0",
"luamin": "^1.0.4",
"typescript": "^5.8.3",
"typescript-eslint": "^8.33.0",
"typescript-to-lua": "^1.31.1",
"typescript-tstl-plugin": "^0.3.2"
},
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
}

14
templates/executable/scripts/postbuild.js Normal file
View File

@@ -0,0 +1,14 @@
const luamin = require("luamin");
const fs = require("fs");
const Path = require("path");
const c = fs.readFileSync(
Path.resolve(__dirname, "../dist/bundle.lua"),
"utf8",
);
const min = luamin.minify(c);
fs.writeFileSync(
Path.resolve(__dirname, "../dist/bundle.min.lua"),
min,
"utf8",
);

1
templates/executable/src/main.ts Normal file
View File

@@ -0,0 +1 @@
print("Hello, world!");

20
templates/executable/tsconfig.json Normal file
View File

@@ -0,0 +1,20 @@
{
"$schema": "https://raw.githubusercontent.com/TypeScriptToLua/TypeScriptToLua/master/tsconfig-schema.json",
"compilerOptions": {
"target": "ESNext",
"lib": ["ESNext"],
"types": ["computercraft-ts"],
"moduleResolution": "Node",
"strict": true,
"plugins": [{ "name": "typescript-tstl-plugin" }],
"outDir": "dist",
"noImplicitAny": false
},
"tstl": {
"luaTarget": "5.4",
"noHeader": true,
"luaBundle": "bundle.lua",
"luaBundleEntry": "src/main.ts"
},
"include": ["src/**/*"]
}

3
templates/library/.gitignore vendored Normal file
View File

@@ -0,0 +1,3 @@
dist/**/*
node_modules
pnpm-lock.yaml

29
templates/library/package.json Normal file
View File

@@ -0,0 +1,29 @@
{
"name": "{{ PROJECT_NAME }}",
"version": "1.0.0",
"description": "",
"license": "ISC",
"author": "",
"type": "commonjs",
"types": "./dist/main.d.ts",
"main": "./dist/main",
"files": [
"dist/**/*.lua",
"dist/**/*.d.ts"
],
"scripts": {
"build": "tstl"
},
"devDependencies": {
"@eslint/js": "^9.27.0",
"computercraft-ts": "^1.0.0",
"eslint": "^9.27.0",
"globals": "^16.2.0",
"luamin": "^1.0.4",
"typescript": "^5.8.3",
"typescript-eslint": "^8.33.0",
"typescript-to-lua": "^1.31.1",
"typescript-tstl-plugin": "^0.3.2"
},
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
}

3
templates/library/src/main.ts Normal file
View File

@@ -0,0 +1,3 @@
export function hello() {
print("Hello, world!");
}

18
templates/library/tsconfig.json Normal file
View File

@@ -0,0 +1,18 @@
{
"$schema": "https://raw.githubusercontent.com/TypeScriptToLua/TypeScriptToLua/master/tsconfig-schema.json",
"compilerOptions": {
"target": "ESNext",
"lib": ["ESNext"],
"moduleResolution": "Node",
"types": ["computercraft-ts"],
"strict": true,
"declaration": true,
"outDir": "dist/",
"rootDir": "src/"
},
"tstl": {
"luaTarget": "JIT",
"buildMode": "library"
},
"include": ["src/**/*"]
}

114
tsconfig.json Normal file
View File

@@ -0,0 +1,114 @@
{
"include": ["src/**/*"],
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "libReplacement": true, /* Enable lib replacement. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "commonjs" /* Specify what module code is generated. */,
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "noUncheckedSideEffectImports": true, /* Check side effect imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "./dist" /* Specify an output folder for all emitted files. */,
// "removeComments": true, /* Disable emitting comments. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
// "erasableSyntaxOnly": true, /* Do not allow runtime constructs that are not part of ECMAScript. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
/* Type Checking */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}