Modernize Build...

.github/workflows/ci.yml

@@ -16,16 +16,16 @@ jobs:
       fail-fast: true
       matrix:
         version:
-          - 16
           - 18
           - 20
+          - 22
           - current
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.version }}
           cache: 'npm'
@@ -41,7 +41,7 @@ jobs:
         run: npm run lint
 
       - name: Test
-        run: npm run cover
+        run: npm run test
 
       - name: Coveralls
         uses: coverallsapp/github-action@v2

.typesyncrc.yaml

@@ -2,10 +2,3 @@ ignorePackages:
   # These packages are dev tools and we don't need their typings.
   - nodemon
   - prettier
-  - rimraf
-  - eslint
-  # Can't upgrade these libraries yet since they require ESM.
-  - chalk
-  - detect-indent
-  - ora
-  - eslint-config-prettier

.vscode/settings.json

@@ -8,9 +8,7 @@
     "**/CVS": true,
     "**/.DS_Store": true,
     "node_modules": true,
-    "coverage": true,
-    "lib": true
+    "coverage": true
   },
-  "typescript.tsdk": "node_modules/typescript/lib",
-  "eslint.useFlatConfig": false
+  "typescript.tsdk": "node_modules/typescript/lib"
 }

README.md

@@ -1,48 +1,46 @@
-# typesync
+# TypeSync
 
 Install missing TypeScript typings for dependencies in your `package.json`.
 
 [![npm](https://img.shields.io/npm/v/typesync.svg?maxAge=1000)](https://www.npmjs.com/package/typesync)
-[![dependency Status](https://img.shields.io/david/jeffijoe/typesync.svg?maxAge=1000)](https://david-dm.org/jeffijoe/typesync)
-[![devDependency Status](https://img.shields.io/david/dev/jeffijoe/typesync.svg?maxAge=1000)](https://david-dm.org/jeffijoe/typesync)
-[![Build Status](https://img.shields.io/travis/jeffijoe/typesync.svg?maxAge=1000)](https://travis-ci.com/jeffijoe/typesync)
+[![Build Status](https://github.com/jeffijoe/typesync/workflows/ci.yml/badge.svg?branch=master)](https://github.com/jeffijoe/typesync/actions)
 [![Coveralls](https://img.shields.io/coveralls/jeffijoe/typesync.svg?maxAge=1000)](https://coveralls.io/github/jeffijoe/typesync)
 [![npm](https://img.shields.io/npm/dt/typesync.svg?maxAge=1000)](https://www.npmjs.com/package/typesync)
-[![npm](https://img.shields.io/npm/l/typesync.svg?maxAge=1000)](https://github.com/jeffijoe/typesync/blob/master/LICENSE.md)
+[![license](https://img.shields.io/npm/l/typesync.svg?maxAge=1000)](https://github.com/jeffijoe/typesync/blob/master/LICENSE.md)
 [![node](https://img.shields.io/node/v/typesync.svg?maxAge=1000)](https://www.npmjs.com/package/typesync)
 
 ![TypeSync](/typesync.gif)
 
-# Install
+## Install
 
-```
+```sh
 npm install -g typesync
 ```
 
 You can also use it directly with `npx` which will install it for you:
 
-```
+```sh
 npx typesync
 ```
 
-# Usage
+## Usage
 
-```
+```sh
 typesync [path/to/package.json] [--dry]
 ```
 
 Path is relative to the current working directory. If omitted, defaults to `package.json`.
 
-**Note**: `typesync` only modifies your `package.json` - you still need to run `npm install`, or — if drinking the k00laid — `yarn`.
+**Note**: TypeSync only modifies your `package.json` - you still need to run an installer.
 
-## `--dry[=fail]`
+### `--dry[=fail]`
 
 If `--dry` is specified, will not actually write to the file, it only prints added/removed typings.
 
 The same is true for `--dry=fail`, with the additional effect of failing the command in case there are changes.
 This is useful for CI scenarios.
 
-## `--ignoredeps`
+### `--ignoredeps`
 
 To ignore certain sections, you can use the `--ignoredeps=` flag. For example, to ignore `devDependencies`, use `--ignoredeps=dev`. To ignore multiple, comma-separate them, like this: `--ignoredeps=deps,peer` (ignores `dependencies` and `peerDependencies`).
 
@@ -51,12 +49,12 @@ To ignore certain sections, you can use the `--ignoredeps=` flag. For example, t
 - `--ignoredeps=peer` — ignores `peerDependencies`
 - `--ignoredeps=optional` — ignores `optionalDependencies`
 
-## `--ignorepackages`
+### `--ignorepackages`
 
 To ignore certain packages, you can use the `--ignorepackages=` flag. For example, to ignore `nodemon`, use `--ignorepackages=nodemon`.
 To ignore multiple, comma-separate them, like this: `--ignorepackages=nodemon,whatever` (ignores `nodemon` and `whatever`).
 
-## Using a config file
+### Using a config file
 
 Alternatively, you can use a TypeSync config file: `.typesyncrc` or a `"typesync"` section in your `package.json`. TypeSync will **automatically** search for configuration files. See [cosmiconfig][cosmiconfig] for details.
 
@@ -68,7 +66,7 @@ Alternatively, you can use a TypeSync config file: `.typesyncrc` or a `"typesync
 }
 ```
 
-## Run TypeSync Automatically After Every Install
+### Run TypeSync automatically after every install
 
 To run TypeSync and install packages automatically after every package install, create a file called `install-with-types.sh` with the following content:
 
@@ -104,39 +102,39 @@ Add the following to `package.json`:
 
 Then install packages like this:
 
-```bash
+```sh
 npm run i <pkg name>
 
-# Or, with yarn:
+# Or with Yarn:
 yarn i <pkg name>
 ```
 
-# Typings packages
+## Typings packages
 
 TypeSync will add typings for packages that:
 
 - have a `@types/package` available
 - don't already provide typings internally (the `typings` and `types` field in `package.json`)
 
-TypeSync will try to respect semver parity for the code and typings packages, and will fall back to the latest available typings package.
+TypeSync will try to respect SemVer parity for the code and typings packages, and will fall back to the latest available typings package.
 
-When writing the typings package version to `package.json`, the `~` semver range is used. This is because typings published via [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped#how-do-definitely-typed-package-versions-relate-to-versions-of-the-corresponding-library) align typings versions with library versions using major and minor only.
+When writing the typings package version to `package.json`, the `~` SemVer range is used. This is because typings published via [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped#how-do-definitely-typed-package-versions-relate-to-versions-of-the-corresponding-library) align typings versions with library versions using major and minor only.
 
 For example, if you depend on `react@^16.14.0`, then TypeSync will only look for typings packages that match `16.14.*`.
 
-# Monorepos
+## Monorepos
 
 TypeSync added support for monorepos in v0.4.0. It will look at `packages`/`workspaces` globs in `package.json` and sync every matching file in one fell swoop.
 
-# Why?
+## Why?
 
 Installing typings manually sucks. Flow has `flow-typed` which installs type definitions by looking at a `package.json`, which would be cool to have for TypeScript. Now we do!
 
-# Changelog
+## Changelog
 
 See [CHANGELOG.md](/CHANGELOG.md)
 
-# Author
+## Author
 
 Jeff Hansen - [@Jeffijoe](https://twitter.com/jeffijoe)
 

bin/typesync

@@ -1,4 +1,4 @@
 #!/usr/bin/env node
-const { startCli } = require('../lib/cli')
+import { startCli } from '../dist/cli.js'
 
-startCli()
+await startCli()

eslint.config.js

@@ -0,0 +1,78 @@
+// @ts-check
+import * as path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import pluginJs from '@eslint/js'
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+
+const dirname = path.dirname(fileURLToPath(import.meta.url))
+
+const extensions = '{js,mjs,cjs,ts}'
+
+export default tseslint.config(
+  {
+    files: [`src/*.${extensions}`, `bin/*`, `*.${extensions}`],
+  },
+  {
+    ignores: [`dist/`, 'coverage/'],
+  },
+  {
+    languageOptions: {
+      globals: globals.node,
+      parserOptions: {
+        projectService: {
+          allowDefaultProject: [`*.config.${extensions}`],
+        },
+        tsconfigRootDir: dirname,
+      },
+    },
+    linterOptions: { reportUnusedDisableDirectives: 'error' },
+  },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  ...tseslint.configs.stylisticTypeChecked,
+  {
+    rules: {
+      // Only disabling these because this code is very old but also battle-tested,
+      // and coming up with clever typings may break for consumers.
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-argument': 'off',
+      '@typescript-eslint/no-unsafe-return': 'off',
+
+      '@typescript-eslint/return-await': ['error', 'always'],
+      '@typescript-eslint/promise-function-async': 'error',
+      '@typescript-eslint/no-confusing-void-expression': 'error',
+      '@typescript-eslint/switch-exhaustiveness-check': 'error',
+
+      // We prefer generic arrays.
+      '@typescript-eslint/array-type': ['error', { default: 'generic' }],
+      // We should ignore unused vars with underscores.
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          args: 'all',
+          argsIgnorePattern: '^_',
+          caughtErrors: 'all',
+          caughtErrorsIgnorePattern: '^_',
+          destructuredArrayIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          ignoreRestSiblings: true,
+        },
+      ],
+      '@typescript-eslint/prefer-nullish-coalescing': [
+        'error',
+        { ignoreConditionalTests: false },
+      ],
+    },
+  },
+  {
+    files: [`src/__tests__/**/*.${extensions}`],
+    rules: {
+      // In tests, sometimes we need to make things asynchronous.
+      '@typescript-eslint/require-await': 'off',
+      '@typescript-eslint/no-empty-function': 'off',
+    },
+  },
+)