Skip to content

Commit

Permalink
refactor(bin): rewrite migrations (#138)
Browse files Browse the repository at this point in the history
  • Loading branch information
RealShadowNova committed Jun 20, 2023
1 parent a5c7ae3 commit 380e3c7
Show file tree
Hide file tree
Showing 33 changed files with 9,641 additions and 2,073 deletions.
2 changes: 1 addition & 1 deletion src/bin/commands/build-docs.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Spinner } from '@favware/colorette-spinner';
import { exec as execSync } from 'node:child_process';
import { promisify } from 'node:util';
import type { Options } from '../lib/types/Options';
import type { Options } from '../lib/types';

const exec = promisify(execSync);

Expand Down
2 changes: 1 addition & 1 deletion src/bin/commands/check-repository.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Spinner } from '@favware/colorette-spinner';
import { existsSync } from 'node:fs';
import { resolve } from 'node:path';
import type { Options } from '../lib/types/Options';
import type { Options } from '../lib/types';

export async function checkRepository(options: Options) {
const spinner = new Spinner().start({ text: 'Checking if "package.json" exists in the current working directory' });
Expand Down
20 changes: 10 additions & 10 deletions src/bin/commands/migrate-docs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ import { Spinner } from '@favware/colorette-spinner';
import { findFilesRecursivelyStringEndsWith } from '@sapphire/node-utilities';
import { readFile, writeFile } from 'node:fs/promises';
import { resolve } from 'node:path';
import { ProjectParser } from '../../lib/structures/ProjectParser';
import { migrateProjectJson } from '../lib/migrateProjectJson';
import type { Options } from '../lib/types/Options';
import type { RequiredExcept } from '../lib/types/RequiredExcept';
import type { Options, RequiredExcept } from '../lib/types';

export async function migrateDocs(options: RequiredExcept<Options, 'json'>) {
const spinner = new Spinner().start({ text: 'Migrating TypeDoc JSON Parser output files' });
Expand All @@ -17,16 +17,16 @@ export async function migrateDocs(options: RequiredExcept<Options, 'json'>) {
for await (const path of findFilesRecursivelyStringEndsWith(directory, '.json')) {
const data = JSON.parse(await readFile(path, 'utf-8'));

if ('typeDocJsonParserVersion' in data) {
const migrated = migrateProjectJson(data);
if ('typeDocJsonParserVersion' in data && data.typeDocJsonParserVersion === ProjectParser.version) continue;

if (typeof migrated === 'string') {
warnings.push(migrated);
} else {
await writeFile(path, JSON.stringify(migrated, null, 2), 'utf-8');
const migrated = migrateProjectJson(data);

migratedFiles++;
}
if (typeof migrated === 'string') {
warnings.push(migrated);
} else {
await writeFile(path, JSON.stringify(migrated, null, 2), 'utf-8');

migratedFiles++;
}
}

Expand Down
3 changes: 1 addition & 2 deletions src/bin/commands/parse-docs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ import { readFile, writeFile } from 'node:fs/promises';
import { resolve } from 'node:path';
import type { JSONOutput } from 'typedoc';
import { ProjectParser } from '../../lib/structures/ProjectParser';
import type { Options } from '../lib/types/Options';
import type { RequiredExcept } from '../lib/types/RequiredExcept';
import type { Options, RequiredExcept } from '../lib/types';

export async function parseDocs(options: RequiredExcept<Options, 'migrate'>) {
const spinner = new Spinner().start({ text: 'Parsing TypeDoc JSON output file' });
Expand Down
3 changes: 1 addition & 2 deletions src/bin/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ import { checkRepository } from './commands/check-repository';
import { migrateDocs } from './commands/migrate-docs';
import { parseDocs } from './commands/parse-docs';
import { parseOptions } from './lib/parseOptions';
import type { Options } from './lib/types/Options';
import type { RequiredExcept } from './lib/types/RequiredExcept';
import type { Options, RequiredExcept } from './lib/types';

async function run() {
const command = new Command()
Expand Down

0 comments on commit 380e3c7

Please sign in to comment.