build: transition to Typescript without Babel #252

Merged
mcataford merged 6 commits from ts-via-tsc-without-babel into master 2021-06-05 15:29:16 +00:00
14 changed files with 2066 additions and 3402 deletions

File diff suppressed because one or more lines are too long

615
.yarn/releases/yarn-sources.cjs vendored Executable file

File diff suppressed because one or more lines are too long

View file

@ -1 +1 @@
yarnPath: .yarn/releases/yarn-2.4.0.cjs yarnPath: .yarn/releases/yarn-sources.cjs

View file

@ -1,3 +1,8 @@
module.exports = { module.exports = {
transformIgnorePatterns: ['.test.js'], transformIgnorePatterns: ['.test.js'],
transform: {
'^.+\\.ts$': 'ts-jest',
},
roots: ['<rootDir>/tests'],
testMatch: ['**/*.test.ts'],
} }

View file

@ -19,7 +19,7 @@
"author": "Marc Cataford <c.marcandre@gmail.com>", "author": "Marc Cataford <c.marcandre@gmail.com>",
"license": "MIT", "license": "MIT",
"files": [ "files": [
"dist/*.ts" "dist/*.js"
], ],
"bin": "./dist/cli.js", "bin": "./dist/cli.js",
"repository": { "repository": {
@ -29,25 +29,21 @@
"scripts": { "scripts": {
"prepack": "yarn build", "prepack": "yarn build",
"prebuild": "rm -rf dist", "prebuild": "rm -rf dist",
"build": "babel src/index.ts src/cli.ts -d dist --extensions .ts", "build": "tsc --project .",
"lint": "eslint src/**/*.ts", "lint": "eslint tests/**/*.ts src/**/*.ts",
"lint:fix": "yarn lint --fix", "lint:fix": "yarn lint --fix",
"test": "jest src", "test": "jest tests",
"test:watch": "yarn test --watchAll", "test:watch": "yarn test --watchAll",
"test:coverage": "yarn test --coverage", "test:coverage": "yarn test --coverage",
"types": "tsc --noEmit src/**/*.ts", "types": "tsc --noEmit src/**/*.ts",
"types:watch": "yarn types --watch" "types:watch": "yarn types --watch"
}, },
"devDependencies": { "devDependencies": {
"@babel/cli": "^7.8.4",
"@babel/core": "^7.8.6",
"@babel/preset-env": "^7.8.7",
"@babel/preset-typescript": "^7.12.7",
"@tophat/eslint-config": "^0.7.0", "@tophat/eslint-config": "^0.7.0",
"@types/jest": "26.0.23", "@types/jest": "26.0.23",
"@types/node": "14.17.2", "@types/node": "14.17.2",
"@typescript-eslint/eslint-plugin": "^4.9.1", "@typescript-eslint/eslint-plugin": "^4.26.0",
"@typescript-eslint/parser": "^4.9.1", "@typescript-eslint/parser": "^4.26.0",
"eslint": "^7.0.0", "eslint": "^7.0.0",
"eslint-config-prettier": "8.3.0", "eslint-config-prettier": "8.3.0",
"eslint-import-resolver-node": "^0.3.4", "eslint-import-resolver-node": "^0.3.4",
@ -56,6 +52,7 @@
"eslint-plugin-prettier": "3.4.0", "eslint-plugin-prettier": "3.4.0",
"jest": "27.0.4", "jest": "27.0.4",
"prettier": "2.3.1", "prettier": "2.3.1",
"typescript": "^4.1.3" "ts-jest": "^27.0.2",
"typescript": "^4.3.2"
} }
} }

13
src/index.d.ts vendored
View file

@ -1,13 +0,0 @@
export type PackwatchArguments = {
cwd?: string
isUpdatingManifest?: boolean
}
export type Report = {
packageSize: string
unpackedSize?: string
packageSizeBytes?: number
unpackedSizeBytes?: number
limit?: string
limitBytes?: number
}

View file

@ -5,17 +5,19 @@ import {
createOrUpdateManifest, createOrUpdateManifest,
getCurrentPackageStats, getCurrentPackageStats,
getPreviousPackageStats, getPreviousPackageStats,
mergeDefaultArguments,
} from './utils' } from './utils'
import type { PackwatchArguments } from './index.d' import type { PackwatchArguments } from './types'
import { assertInPackageRoot } from './invariants' import { assertInPackageRoot } from './invariants'
import logger from './logger' import logger from './logger'
const MANIFEST_FILENAME = '.packwatch.json' const MANIFEST_FILENAME = '.packwatch.json'
export default async function packwatch({ export default async function packwatch(
cwd, args: Partial<PackwatchArguments>,
isUpdatingManifest, ): Promise<void> {
}: PackwatchArguments): Promise<void> { const { cwd, isUpdatingManifest } = mergeDefaultArguments(args)
const manifestPath = resolve(join(cwd, MANIFEST_FILENAME)) const manifestPath = resolve(join(cwd, MANIFEST_FILENAME))
assertInPackageRoot(cwd) assertInPackageRoot(cwd)
@ -50,7 +52,7 @@ export default async function packwatch({
limit, limit,
limitBytes, limitBytes,
} = previousStats } = previousStats
const hasExceededLimit = packageSizeBytes > limitBytes const hasExceededLimit = limitBytes && packageSizeBytes > limitBytes
/* /*
* If we are updating the manifest, we can write right away and terminate. * If we are updating the manifest, we can write right away and terminate.

13
src/types.ts Normal file
View file

@ -0,0 +1,13 @@
export type PackwatchArguments = {
cwd: string
isUpdatingManifest: boolean
}
export type Report = {
packageSize: string
unpackedSize: string
packageSizeBytes: number
unpackedSizeBytes: number
limit?: string
limitBytes?: number
}

View file

@ -2,7 +2,7 @@ import { spawnSync } from 'child_process'
import { readFileSync, writeFileSync } from 'fs' import { readFileSync, writeFileSync } from 'fs'
import { join, resolve } from 'path' import { join, resolve } from 'path'
import { Report } from './index.d' import { PackwatchArguments, Report } from './types'
const PACKAGE_SIZE_PATT = /package size:\s*([0-9]+\.?[0-9]*\s+[A-Za-z]{1,2})/ const PACKAGE_SIZE_PATT = /package size:\s*([0-9]+\.?[0-9]*\s+[A-Za-z]{1,2})/
const UNPACKED_SIZE_PATT = /unpacked size:\s*([0-9]+\.?[0-9]*\s+[A-Za-z]{1,2})/ const UNPACKED_SIZE_PATT = /unpacked size:\s*([0-9]+\.?[0-9]*\s+[A-Za-z]{1,2})/
@ -11,9 +11,18 @@ const SIZE_MAGNITUDE_PATT = /([0-9]+\.?[0-9]*)/
const MANIFEST_FILENAME = '.packwatch.json' const MANIFEST_FILENAME = '.packwatch.json'
export function mergeDefaultArguments(
args: Partial<PackwatchArguments>,
): PackwatchArguments {
return {
cwd: args.cwd ?? '.',
isUpdatingManifest: args.isUpdatingManifest ?? false,
}
}
export function convertSizeToBytes(sizeString: string): number { export function convertSizeToBytes(sizeString: string): number {
const sizeSuffix = SIZE_SUFFIX_PATT.exec(sizeString)[1] const sizeSuffix = SIZE_SUFFIX_PATT.exec(sizeString)?.[1] ?? ''
const sizeMagnitude = SIZE_MAGNITUDE_PATT.exec(sizeString)[1] const sizeMagnitude = SIZE_MAGNITUDE_PATT.exec(sizeString)?.[1] ?? '0.0'
let multiplier = 1 let multiplier = 1
@ -31,8 +40,8 @@ export function getCurrentPackageStats(cwd: string): Report {
cwd, cwd,
}) })
const stderrString = String(stderr) const stderrString = String(stderr)
const packageSize = PACKAGE_SIZE_PATT.exec(stderrString)[1] const packageSize = PACKAGE_SIZE_PATT.exec(stderrString)?.[1] ?? '0'
const unpackedSize = UNPACKED_SIZE_PATT.exec(stderrString)[1] const unpackedSize = UNPACKED_SIZE_PATT.exec(stderrString)?.[1] ?? '0'
return { return {
packageSize, packageSize,
@ -42,7 +51,7 @@ export function getCurrentPackageStats(cwd: string): Report {
} }
} }
export function getPreviousPackageStats(cwd: string): Report | null { export function getPreviousPackageStats(cwd: string): Report {
const manifestPath = resolve(join(cwd, MANIFEST_FILENAME)) const manifestPath = resolve(join(cwd, MANIFEST_FILENAME))
try { try {
const currentManifest = readFileSync(manifestPath, { const currentManifest = readFileSync(manifestPath, {
@ -57,6 +66,13 @@ export function getPreviousPackageStats(cwd: string): Report | null {
} }
} catch { } catch {
/* No manifest */ /* No manifest */
return {
packageSize: '0',
packageSizeBytes: 0,
unpackedSizeBytes: 0,
unpackedSize: '0',
limitBytes: 0,
}
} }
} }

View file

@ -2,12 +2,14 @@ import { promises as fs } from 'fs'
import { tmpdir } from 'os' import { tmpdir } from 'os'
import { join, resolve } from 'path' import { join, resolve } from 'path'
import logger from '../logger' import type { Report } from '../src/types'
import type { Report } from '../index.d' import packwatch from '../src'
import packwatch from '..'
let workspace: string | null
async function prepareWorkspace(): Promise<string> { async function prepareWorkspace(): Promise<string> {
const workspacePath = await fs.mkdtemp(`${tmpdir()}/`) const workspacePath = await fs.mkdtemp(`${tmpdir()}/`)
workspace = workspacePath
return workspacePath return workspacePath
} }
@ -36,28 +38,21 @@ async function createManifest(
const path = resolve(join(cwd, '.packwatch.json')) const path = resolve(join(cwd, '.packwatch.json'))
await createFile(path, JSON.stringify(configuration)) await createFile(path, JSON.stringify(configuration))
} }
describe('Packwatch', () => {
let mockLogger
let mockWarn
let mockError
let workspacePath
beforeEach(() => {
mockLogger = jest.spyOn(console, 'log').mockImplementation()
mockWarn = jest.spyOn(console, 'warn').mockImplementation()
mockError = jest.spyOn(console, 'error').mockImplementation()
})
describe('Packwatch', () => {
afterEach(async () => { afterEach(async () => {
jest.restoreAllMocks() jest.restoreAllMocks()
if (workspacePath) { if (workspace) {
await cleanUpWorkspace([workspacePath]) await cleanUpWorkspace([workspace])
workspacePath = null workspace = null
} }
}) })
it('warns the user and errors if run away from package.json', async () => { it('warns the user and errors if run away from package.json', async () => {
workspacePath = await prepareWorkspace() const workspacePath = await prepareWorkspace()
const mockLogger = jest.spyOn(console, 'log')
await expect(async () => await expect(async () =>
packwatch({ cwd: workspacePath }), packwatch({ cwd: workspacePath }),
).rejects.toThrow('NOT_IN_PACKAGE_ROOT') ).rejects.toThrow('NOT_IN_PACKAGE_ROOT')
@ -72,7 +67,7 @@ describe('Packwatch', () => {
describe('without manifest', () => { describe('without manifest', () => {
it('generates the initial manifest properly', async () => { it('generates the initial manifest properly', async () => {
workspacePath = await prepareWorkspace() const workspacePath = await prepareWorkspace()
await createPackageJson(workspacePath) await createPackageJson(workspacePath)
await expect(async () => await expect(async () =>
@ -90,7 +85,9 @@ describe('Packwatch', () => {
}) })
it('outputs expected messaging', async () => { it('outputs expected messaging', async () => {
workspacePath = await prepareWorkspace() const workspacePath = await prepareWorkspace()
const mockWarn = jest.spyOn(console, 'warn')
const mockError = jest.spyOn(console, 'error')
await createPackageJson(workspacePath) await createPackageJson(workspacePath)
await expect(async () => await expect(async () =>
@ -112,7 +109,8 @@ describe('Packwatch', () => {
}) })
it('outputs expected messaging when not updating the manifest', async () => { it('outputs expected messaging when not updating the manifest', async () => {
workspacePath = await prepareWorkspace() const mockWarn = jest.spyOn(console, 'warn')
const workspacePath = await prepareWorkspace()
await createPackageJson(workspacePath) await createPackageJson(workspacePath)
@ -129,13 +127,15 @@ describe('Packwatch', () => {
describe('with manifest', () => { describe('with manifest', () => {
it('messages when the size is equal to the limit', async () => { it('messages when the size is equal to the limit', async () => {
workspacePath = await prepareWorkspace() const workspacePath = await prepareWorkspace()
const mockLogger = jest.spyOn(console, 'log')
await createPackageJson(workspacePath) await createPackageJson(workspacePath)
await createManifest(workspacePath, { await createManifest(workspacePath, {
limit: '160B', limit: '160B',
packageSize: '160B', packageSize: '160B',
packageSizeBytes: 160,
unpackedSize: '150B', unpackedSize: '150B',
unpackedSizeBytes: 150,
}) })
await packwatch({ cwd: workspacePath }) await packwatch({ cwd: workspacePath })
expect(mockLogger.mock.calls).toHaveLength(1) expect(mockLogger.mock.calls).toHaveLength(1)
@ -147,13 +147,15 @@ describe('Packwatch', () => {
}) })
it('messages when the size is lower than the limit (no growth)', async () => { it('messages when the size is lower than the limit (no growth)', async () => {
workspacePath = await prepareWorkspace() const workspacePath = await prepareWorkspace()
const mockLogger = jest.spyOn(console, 'log')
await createPackageJson(workspacePath) await createPackageJson(workspacePath)
await createManifest(workspacePath, { await createManifest(workspacePath, {
limit: '170B', limit: '170B',
packageSize: '160B', packageSize: '160B',
packageSizeBytes: 160,
unpackedSize: '150B', unpackedSize: '150B',
unpackedSizeBytes: 150,
}) })
await packwatch({ cwd: workspacePath }) await packwatch({ cwd: workspacePath })
@ -165,13 +167,15 @@ describe('Packwatch', () => {
) )
}) })
it('messages when the size is lower than the limit (growth)', async () => { it('messages when the size is lower than the limit (growth)', async () => {
workspacePath = await prepareWorkspace() const workspacePath = await prepareWorkspace()
const mockLogger = jest.spyOn(console, 'log')
await createPackageJson(workspacePath) await createPackageJson(workspacePath)
await createManifest(workspacePath, { await createManifest(workspacePath, {
limit: '180B', limit: '180B',
packageSize: '150B', packageSize: '150B',
packageSizeBytes: 150,
unpackedSize: '140B', unpackedSize: '140B',
unpackedSizeBytes: 140,
}) })
await packwatch({ cwd: workspacePath }) await packwatch({ cwd: workspacePath })
@ -183,13 +187,15 @@ describe('Packwatch', () => {
) )
}) })
it('messages when the size is lower than the limit (shrinkage)', async () => { it('messages when the size is lower than the limit (shrinkage)', async () => {
workspacePath = await prepareWorkspace() const workspacePath = await prepareWorkspace()
const mockLogger = jest.spyOn(console, 'log')
await createPackageJson(workspacePath) await createPackageJson(workspacePath)
await createManifest(workspacePath, { await createManifest(workspacePath, {
limit: '180B', limit: '180B',
packageSize: '170B', packageSize: '170B',
packageSizeBytes: 170,
unpackedSize: '140B', unpackedSize: '140B',
unpackedSizeBytes: 140,
}) })
await packwatch({ cwd: workspacePath }) await packwatch({ cwd: workspacePath })
@ -201,13 +207,15 @@ describe('Packwatch', () => {
) )
}) })
it('messages when the size exceeds the limit', async () => { it('messages when the size exceeds the limit', async () => {
workspacePath = await prepareWorkspace() const workspacePath = await prepareWorkspace()
const mockError = jest.spyOn(console, 'error')
await createPackageJson(workspacePath) await createPackageJson(workspacePath)
await createManifest(workspacePath, { await createManifest(workspacePath, {
limit: '10B', limit: '10B',
packageSize: '170B', packageSize: '170B',
packageSizeBytes: 170,
unpackedSize: '140B', unpackedSize: '140B',
unpackedSizeBytes: 140,
}) })
await expect(async () => await expect(async () =>
@ -222,13 +230,15 @@ describe('Packwatch', () => {
}) })
it('messages when updating the manifest', async () => { it('messages when updating the manifest', async () => {
workspacePath = await prepareWorkspace() const workspacePath = await prepareWorkspace()
const mockLogger = jest.spyOn(console, 'log')
await createPackageJson(workspacePath) await createPackageJson(workspacePath)
await createManifest(workspacePath, { await createManifest(workspacePath, {
limit: '10B', limit: '10B',
packageSize: '170B', packageSize: '170B',
packageSizeBytes: 170,
unpackedSize: '140B', unpackedSize: '140B',
unpackedSizeBytes: 140,
}) })
await packwatch({ cwd: workspacePath, isUpdatingManifest: true }) await packwatch({ cwd: workspacePath, isUpdatingManifest: true })

View file

@ -1,4 +1,4 @@
import { convertSizeToBytes } from '../utils' import { convertSizeToBytes } from '../src/utils'
describe('utils', () => { describe('utils', () => {
it.each` it.each`

73
tsconfig.json Normal file
View file

@ -0,0 +1,73 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
"allowJs": false, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
"declaration": true, /* Generates corresponding '.d.ts' file. */
"declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
"sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./dist", /* Redirect output structure to the directory. */
"rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
"removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */
/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
/* Advanced Options */
"skipLibCheck": true, /* Skip type checking of declaration files. */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
},
"exclude": ["dist/**/*", "tests/**/*"]
}

4555
yarn.lock

File diff suppressed because it is too large Load diff