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.

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

feat: CLI for quick scaffolding #277

Merged
merged 20 commits into from
Nov 11, 2023
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
chore: update
antfu committed Nov 10, 2023
commit f27e2d4eba6d10351d4acafcd4e020dde05cef45
6 changes: 0 additions & 6 deletions src/cli/index.ts
Original file line number Diff line number Diff line change
@@ -17,12 +17,6 @@ const instance = yargs(hideBin(process.argv))
'migrate',
'Migrate from legacy config to new flat config',
args => args
// .option('detail', {
// alias: 'a',
// default: false,
// describe: 'show more info',
// type: 'boolean',
// })
.help(),
async (_args) => {
header()
2 changes: 1 addition & 1 deletion src/cli/run.ts
Original file line number Diff line number Diff line change
@@ -84,7 +84,7 @@ module.exports = antfu({\n${antfuConfig}\n})
legacyConfig.push(file)
})
if (legacyConfig.length)
console.log(`${WARN} You can now remove those files manually:`, c.dim(legacyConfig.join(', ')), '\n')
console.log(`${WARN} you can now remove those files manually:`, c.dim(legacyConfig.join(', ')), '\n')

// End update eslint files
// Update .vscode/settings.json
11 changes: 6 additions & 5 deletions test/cli.spec.ts
Original file line number Diff line number Diff line change
@@ -43,7 +43,7 @@ it('package.json updated', async () => {
const pkgContent: Record<string, any> = await fs.readJSON(join(genPath, 'package.json'))

expect(JSON.stringify(pkgContent.devDependencies)).toContain('@antfu/eslint-config')
expect(stdout).toContain('Updated - package.json')
expect(stdout).toContain('changes wrote to package.json')
})

it('esm eslint.config.js', async () => {
@@ -54,15 +54,15 @@ it('esm eslint.config.js', async () => {

const eslintConfigContent = await fs.readFile(join(genPath, 'eslint.config.js'), 'utf-8')
expect(eslintConfigContent.includes('export default')).toBeTruthy()
expect(stdout).toContain('Created - eslint.config.js')
expect(stdout).toContain('created eslint.config.js')
})

it('cjs eslint.config.js', async () => {
const { stdout } = await run()

const eslintConfigContent = await fs.readFile(join(genPath, 'eslint.config.js'), 'utf-8')
expect(eslintConfigContent.includes('module.exports')).toBeTruthy()
expect(stdout).toContain('Created - eslint.config.js')
expect(stdout).toContain('created eslint.config.js')
})

it('ignores files added in eslint.config.js', async () => {
@@ -71,11 +71,12 @@ it('ignores files added in eslint.config.js', async () => {
const eslintConfigContent = (await fs.readFile(join(genPath, 'eslint.config.js'), 'utf-8')).replace(/\s+/g, '')

expect(eslintConfigContent.includes('ignores:["some-path","**/some-path/**","some-file","**/some-file/**"]')).toBeTruthy()
expect(stdout).toContain('Created - eslint.config.js')
expect(stdout).toContain('created eslint.config.js')
})

it('suggest remove unnecessary files', async () => {
const { stdout } = await run()

expect(stdout).toContain('You can now remove those files: .eslintignore, .eslintrc.yml, .prettierc, .prettierignore, eslint.config.js')
expect(stdout).toContain('you can now remove those files manually')
expect(stdout).toContain('.eslintignore, .eslintrc.yml, .prettierc, .prettierignore, eslint.config.js')
})