Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: support languages json/markdown #151

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

feat: support languages json/markdown #151

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c5da34e
feat: add question langauges
aladdin-add Oct 16, 2024
bbb24ef
chore: languages => ["javascript"]
aladdin-add Oct 23, 2024
77337f8
feat: support json/md
aladdin-add Oct 25, 2024
cd750b8
chore: add tests for json/md
aladdin-add Nov 4, 2024
db14381
fix: review suggestions
aladdin-add Nov 7, 2024
08bd343
fix: add global ignores
aladdin-add Nov 8, 2024
16e8eab
fix: add plugins
aladdin-add Nov 8, 2024
afb72a1
Update bin/create-config.js
aladdin-add Nov 8, 2024
effc9b1
Update lib/questions.js
aladdin-add Nov 8, 2024
cabfdc9
fix: languages defaults to ["javascript"]
aladdin-add Nov 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bin/create-config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ if (sharedConfigIndex === -1) {
// passed "--config"
const packageName = argv[sharedConfigIndex + 1];
const type = argv.includes("--eslintrc") ? "eslintrc" : "flat";
const answers = { config: { packageName, type } };
const answers = { config: { packageName, type }, language: ["javascript"] };
aladdin-add marked this conversation as resolved.
Show resolved Hide resolved
const generator = new ConfigGenerator({ cwd, packageJsonPath, answers });

generator.calc();
Expand Down
241 changes: 115 additions & 126 deletions lib/config-generator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,18 @@ import enquirer from "enquirer";
import { isPackageTypeModule, installSyncSaveDev, fetchPeerDependencies, findPackageJson } from "./utils/npm-utils.js";
import { getShorthandName } from "./utils/naming.js";
import * as log from "./utils/logging.js";
import { langQuestions, jsQuestions, mdQuestions, installationQuestions } from "./questions.js";

const helperContent = `import path from "path";
import { fileURLToPath } from "url";
import { FlatCompat } from "@eslint/eslintrc";
import pluginJs from "@eslint/js";

// mimic CommonJS variables -- not needed if using CommonJS
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const compat = new FlatCompat({baseDirectory: __dirname, recommendedConfig: pluginJs.configs.recommended});
`;

/**
* Class representing a ConfigGenerator.
Expand Down Expand Up @@ -40,65 +52,15 @@ export class ConfigGenerator {
* @returns {void}
*/
async prompt() {
const questions = [
{
type: "select",
name: "purpose",
message: "How would you like to use ESLint?",
initial: 1,
choices: [
{ message: "To check syntax only", name: "syntax" },
{ message: "To check syntax and find problems", name: "problems" }
]
},
{
type: "select",
name: "moduleType",
message: "What type of modules does your project use?",
initial: 0,
choices: [
{ message: "JavaScript modules (import/export)", name: "esm" },
{ message: "CommonJS (require/exports)", name: "commonjs" },
{ message: "None of these", name: "script" }
]
},
{
type: "select",
name: "framework",
message: "Which framework does your project use?",
initial: 0,
choices: [
{ message: "React", name: "react" },
{ message: "Vue.js", name: "vue" },
{ message: "None of these", name: "none" }
]
},
{
type: "select",
name: "language",
message: "Does your project use TypeScript?",
choices: [
{ message: "No", name: "javascript" },
{ message: "Yes", name: "typescript" }
],
initial: 0
},
{
type: "multiselect",
name: "env",
message: "Where does your code run?",
hint: "(Press <space> to select, <a> to toggle all, <i> to invert selection)",
initial: 0,
choices: [
{ message: "Browser", name: "browser" },
{ message: "Node", name: "node" }
]
}
];
Object.assign(this.answers, await enquirer.prompt(langQuestions));
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

didn't use skip - as there is a known issue when using multi-selection: enquirer/enquirer#298


const answers = await enquirer.prompt(questions);
if (this.answers.languages.includes("javascript")) {
Object.assign(this.answers, await enquirer.prompt(jsQuestions));
}

Object.assign(this.answers, answers);
if (this.answers.languages.includes("md")) {
Object.assign(this.answers, await enquirer.prompt(mdQuestions));
}
}

/**
Expand All @@ -107,6 +69,7 @@ export class ConfigGenerator {
*/
calc() {
const isESMModule = isPackageTypeModule(this.packageJsonPath);
const useTs = this.answers.useTs;

this.result.configFilename = isESMModule ? "eslint.config.js" : "eslint.config.mjs";
this.answers.config = typeof this.answers.config === "string"
Expand All @@ -115,73 +78,116 @@ export class ConfigGenerator {
const extensions = []; // file extensions to lint, the default is ["js", "mjs", "cjs"]

let importContent = "";
const helperContent = `import path from "path";
import { fileURLToPath } from "url";
import { FlatCompat } from "@eslint/eslintrc";
import pluginJs from "@eslint/js";

// mimic CommonJS variables -- not needed if using CommonJS
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const compat = new FlatCompat({baseDirectory: __dirname, recommendedConfig: pluginJs.configs.recommended});
`;
let exportContent = "";
let needCompatHelper = false;
const languages = this.answers.languages;
const purpose = this.answers.purpose;

if (this.answers.moduleType === "commonjs" || this.answers.moduleType === "script") {
exportContent += ` {files: ["**/*.js"], languageOptions: {sourceType: "${this.answers.moduleType}"}},\n`;
}
if (languages?.includes("javascript")) {
if (this.answers.moduleType === "commonjs" || this.answers.moduleType === "script") {
exportContent += ` {files: ["**/*.js"], languageOptions: {sourceType: "${this.answers.moduleType}"}},\n`;
}

if (this.answers.env?.length > 0) {
this.result.devDependencies.push("globals");
importContent += "import globals from \"globals\";\n";
const envContent = {
browser: "globals: globals.browser",
node: "globals: globals.node",
"browser,node": "globals: {...globals.browser, ...globals.node}"
};
if (this.answers.env?.length > 0) {
this.result.devDependencies.push("globals");
importContent += "import globals from \"globals\";\n";
const envContent = {
browser: "globals: globals.browser",
node: "globals: globals.node",
"browser,node": "globals: {...globals.browser, ...globals.node}"
};

exportContent += ` {languageOptions: { ${envContent[this.answers.env.join(",")]} }},\n`;
}
exportContent += ` {languageOptions: { ${envContent[this.answers.env.join(",")]} }},\n`;
}

if (purpose === "syntax") {

// no need to install any plugin
} else if (purpose === "problems") {
aladdin-add marked this conversation as resolved.
Show resolved Hide resolved
this.result.devDependencies.push("@eslint/js");
importContent += "import pluginJs from \"@eslint/js\";\n";
exportContent += " pluginJs.configs.recommended,\n";
}

if (useTs) {
extensions.push("ts");
this.result.devDependencies.push("typescript-eslint");
importContent += "import tseslint from \"typescript-eslint\";\n";
exportContent += " ...tseslint.configs.recommended,\n";
}

if (this.answers.framework === "vue") {
extensions.push("vue");
this.result.devDependencies.push("eslint-plugin-vue");
importContent += "import pluginVue from \"eslint-plugin-vue\";\n";
exportContent += " ...pluginVue.configs[\"flat/essential\"],\n";

// https://eslint.vuejs.org/user-guide/#how-to-use-a-custom-parser
if (useTs) {
exportContent += " {files: [\"**/*.vue\"], languageOptions: {parserOptions: {parser: tseslint.parser}}},\n";
}
}

if (this.answers.framework === "react") {
extensions.push("jsx");

if (useTs) {
extensions.push("tsx");
}

if (this.answers.purpose === "syntax") {
this.result.devDependencies.push("eslint-plugin-react");
importContent += "import pluginReact from \"eslint-plugin-react\";\n";
exportContent += " pluginReact.configs.flat.recommended,\n";
}
} else {
exportContent += " {ignores: [\"**/*.js\", \"**/*.cjs\", \"**/*.mjs\"]},\n";
}

// no need to install any plugin
} else if (this.answers.purpose === "problems") {
this.result.devDependencies.push("@eslint/js");
importContent += "import pluginJs from \"@eslint/js\";\n";
exportContent += " pluginJs.configs.recommended,\n";
if (languages?.some(item => item.startsWith("json"))) {
this.result.devDependencies.push("@eslint/json");
importContent += "import json from \"@eslint/json\";\n";
}
if (languages?.includes("json")) {
const config = purpose === "syntax"
? " {files: [\"**/*.json\"], plugins: {json}, language: \"json/json\"},\n"
: " {files: [\"**/*.json\"], language: \"json/json\", ...json.configs.recommended},\n";

if (this.answers.language === "typescript") {
extensions.push("ts");
this.result.devDependencies.push("typescript-eslint");
importContent += "import tseslint from \"typescript-eslint\";\n";
exportContent += " ...tseslint.configs.recommended,\n";
exportContent += config;
}
if (languages?.includes("jsonc")) {
const config = purpose === "syntax"
? " {files: [\"**/*.jsonc\"], plugins: {json}, language: \"json/jsonc\"},\n"
: " {files: [\"**/*.jsonc\"], language: \"json/jsonc\", ...json.configs.recommended},\n";

if (this.answers.framework === "vue") {
extensions.push("vue");
this.result.devDependencies.push("eslint-plugin-vue");
importContent += "import pluginVue from \"eslint-plugin-vue\";\n";
exportContent += " ...pluginVue.configs[\"flat/essential\"],\n";
exportContent += config;
}
if (languages?.includes("json5")) {
const config = purpose === "syntax"
? " {files: [\"**/*.json5\"], plugins: {json}, language: \"json/json5\"},\n"
: " {files: [\"**/*.json5\"], language: \"json/json5\", ...json.configs.recommended},\n";

// https://eslint.vuejs.org/user-guide/#how-to-use-a-custom-parser
if (this.answers.language === "typescript") {
exportContent += " {files: [\"**/*.vue\"], languageOptions: {parserOptions: {parser: tseslint.parser}}},\n";
}
exportContent += config;
}

if (this.answers.framework === "react") {
extensions.push("jsx");
if (languages?.includes("md")) {
this.result.devDependencies.push("@eslint/markdown");
importContent += "import markdown from \"@eslint/markdown\";\n";

if (this.answers.language === "typescript") {
extensions.push("tsx");
}
if (purpose === "syntax") {
const config = this.answers.mdType === "commonmark"
? " {files: [\"**/*.md\"], plugins: {markdown}, language: \"markdown/commonmark\"},\n"
: " {files: [\"**/*.md\"], plugins: {markdown}, language: \"markdown/gfm\"},\n";

exportContent += config;
} else if (purpose === "problems") {
exportContent += " ...markdown.configs.recommended,\n";

if (this.answers.mdType === "gfm") {

this.result.devDependencies.push("eslint-plugin-react");
importContent += "import pluginReact from \"eslint-plugin-react\";\n";
exportContent += " pluginReact.configs.flat.recommended,\n";
// the default is commonmark
exportContent += " {files: [\"**/*.md\"], language: \"markdown/gfm\"},\n";
}
}
}

if (this.answers.config) {
Expand Down Expand Up @@ -243,24 +249,7 @@ export default [\n${exportContent}];`;
log.info("The config that you've selected requires the following dependencies:\n");
log.info(this.result.devDependencies.join(", "));

const questions = [{
type: "toggle",
name: "executeInstallation",
message: "Would you like to install them now?",
enabled: "Yes",
disabled: "No",
initial: 1
}, {
type: "select",
name: "packageManager",
message: "Which package manager do you want to use?",
initial: 0,
choices: ["npm", "yarn", "pnpm", "bun"],
skip() {
return this.state.answers.executeInstallation === false;
}
}];
const { executeInstallation, packageManager } = (await enquirer.prompt(questions));
const { executeInstallation, packageManager } = (await enquirer.prompt(installationQuestions));
const configPath = path.join(this.cwd, this.result.configFilename);

if (executeInstallation === true) {
Expand Down
Loading