Require Node.js 18 and move to ESM

.github/workflows/main.yml

@@ -10,13 +10,11 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
-          - 14
-          - 12
-          - 10
-          - 8
+          - 20
+          - 18
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install

cli.js

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
-'use strict';
-const meow = require('meow');
-const catNames = require('.');
+import meow from 'meow';
+import {catNames, randomCatName} from './index.js';
 
 const cli = meow(`
 	Examples
@@ -15,6 +14,8 @@ const cli = meow(`
 
 	Options
 	  --all  Get all names instead of a random name
-`);
+`, {
+	importMeta: import.meta,
+});
 
-console.log(cli.flags.all ? catNames.all.join('\n') : catNames.random());
+console.log(cli.flags.all ? catNames.join('\n') : randomCatName());

index.d.ts

@@ -1,31 +1,25 @@
-import catNamesJson = require('./cat-names.json');
+/**
+Top 100 cat names in alphabetical order.
 
-declare const catNames: {
-	/**
-	Top 100 cat names in alphabetical order.
+@example
+```
+import {catNames} from 'cat-names';
 
-	@example
-	```
-	import catNames = require('cat-names');
+catNames;
+//=> ['Abby', 'Angel', …]
+```
+*/
+export const catNames: readonly string[];
 
-	catNames.all;
-	//=> ['Abby', 'Angel', …]
-	```
-	*/
-	readonly all: Readonly<typeof catNamesJson>;
+/**
+Get a random cat name.
 
-	/**
-	Random cat name.
+@example
+```
+import {randomCatName} from 'cat-names';
 
-	@example
-	```
-	import catNames = require('cat-names');
-
-	catNames.random();
-	//=> 'Max'
-	```
-	*/
-	random(): string;
-};
-
-export = catNames;
+randomCatName();
+//=> 'Max'
+```
+*/
+export function randomCatName(): string;

index.js

@@ -1,6 +1,6 @@
-'use strict';
-const uniqueRandomArray = require('unique-random-array');
-const catNames = require('./cat-names.json');
+import uniqueRandomArray from 'unique-random-array';
+import catNames from './cat-names.json' with {type: 'json'};
 
-exports.all = catNames;
-exports.random = uniqueRandomArray(catNames);
+export {catNames};
+
+export const randomCatName = uniqueRandomArray(catNames);

index.test-d.ts

@@ -1,5 +1,5 @@
 import {expectType} from 'tsd';
-import catNames = require('.');
+import {catNames, randomCatName} from './index.js';
 
-expectType<readonly string[]>(catNames.all);
-expectType<string>(catNames.random());
+expectType<readonly string[]>(catNames);
+expectType<string>(randomCatName());

license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <[email protected]> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <[email protected]> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package.json

@@ -4,17 +4,25 @@
 	"description": "Get popular cat names",
 	"license": "MIT",
 	"repository": "sindresorhus/cat-names",
+	"funding": "https://github.com/sponsors/sindresorhus",
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "[email protected]",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
-	"bin": "cli.js",
+	"type": "module",
+	"bin": "./cli.js",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
+	"sideEffects": false,
 	"engines": {
-		"node": ">=8"
+		"node": ">=18.20"
 	},
 	"scripts": {
-		"test": "xo && ava && tsd"
+		"//test": "xo && ava && tsd",
+		"test": "ava && tsd"
 	},
 	"files": [
 		"index.js",
@@ -42,22 +50,12 @@
 		"male"
 	],
 	"dependencies": {
-		"meow": "^6.1.1",
-		"unique-random-array": "^2.0.0"
+		"meow": "^13.2.0",
+		"unique-random-array": "^3.0.0"
 	},
 	"devDependencies": {
-		"ava": "^1.4.1",
-		"tsd": "^0.7.2",
-		"xo": "^0.24.0"
-	},
-	"tsd": {
-		"compilerOptions": {
-			"resolveJsonModule": true
-		}
-	},
-	"xo": {
-		"rules": {
-			"import/extensions": "off"
-		}
+		"ava": "^6.1.2",
+		"tsd": "^0.31.0",
+		"xo": "^0.58.0"
 	}
 }

readme.md

@@ -8,46 +8,42 @@ The name list is just a [JSON file](cat-names.json) and can be used anywhere.
 
 *I'm not accepting PRs for additional names.*
 
-
 ## Install
 
+```sh
+npm install cat-names
 ```
-$ npm install cat-names
-```
-
 
 ## Usage
 
 ```js
-const catNames = require('cat-names');
+import {catNames, randomCatName} from 'cat-names';
 
-catNames.all;
+catNames;
 //=> ['Abby', 'Angel', …]
 
-catNames.random();
+randomCatName();
 //=> 'Max'
 ```
 
-
 ## API
 
-### .all
+### catNames
 
 Type: `string[]`
 
 Top 100 cat names in alphabetical order.
 
-### .random()
+### randomCatName()
 
 Type: `Function`
 
-Random cat name.
-
+Get a random cat name.
 
 ## CLI
 
-```
-$ npm install --global cat-names
+```sh
+npm install --global cat-names
 ```
 
 ```
@@ -66,7 +62,6 @@ $ cat-names --help
     --all  Get all names instead of a random name
 ```
 
-
 ## Related
 
 - [dog-names](https://github.com/sindresorhus/dog-names) - Get popular dog names
@@ -76,8 +71,3 @@ $ cat-names --help
 - [supervillains](https://github.com/sindresorhus/supervillains) - Get supervillain names
 - [random-tree-names](https://github.com/pguth/random-tree-names) - Get tree names
 - [yes-no-words](https://github.com/sindresorhus/yes-no-words) - Get yes/no like words
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)

test.js

@@ -1,10 +1,10 @@
 import test from 'ava';
-import catNames from '.';
+import {catNames, randomCatName} from './index.js';
 
 test('main', t => {
-	t.true(catNames.all.length > 0);
-	t.truthy(catNames.random());
-	t.not(catNames.random(), catNames.random());
-	t.is(catNames.all[0], 'Abby');
-	t.is(catNames.all[1], 'Angel');
+	t.true(catNames.length > 0);
+	t.truthy(randomCatName());
+	t.not(randomCatName(), randomCatName());
+	t.is(catNames[0], 'Abby');
+	t.is(catNames[1], 'Angel');
 });