[patch] add types

inspect-js · Feb 1, 2024 · 9276414 · 9276414
1 parent 07f3eaf
commit 9276414
Show file tree

Hide file tree

Showing 17 changed files with 119 additions and 36 deletions.
diff --git a/.github/workflows/node-10-11.yml b/.github/workflows/node-10-11.yml
@@ -30,13 +30,13 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   minors:
     needs: [matrix, latest]
@@ -55,13 +55,13 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   node:
     name: 'node v10 - v11'

diff --git a/.github/workflows/node-12-13.yml b/.github/workflows/node-12-13.yml
@@ -30,13 +30,13 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   minors:
     needs: [matrix, latest]
@@ -55,13 +55,13 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   node:
     name: 'node v12 - v13'

diff --git a/.github/workflows/node-14-15.yml b/.github/workflows/node-14-15.yml
@@ -30,13 +30,13 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   minors:
     needs: [matrix, latest]
@@ -55,13 +55,13 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   node:
     name: 'node v14 - v15'

diff --git a/.github/workflows/node-16+.yml b/.github/workflows/node-16+.yml
@@ -29,13 +29,13 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   minors:
     needs: [matrix, latest]
@@ -53,13 +53,13 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   node:
     name: 'node v16+'

diff --git a/.github/workflows/node-4-6.yml b/.github/workflows/node-4-6.yml
@@ -30,13 +30,14 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
+          skip-ls-check: true
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   minors:
     needs: [matrix, latest]
@@ -55,13 +56,14 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
+          skip-ls-check: true
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   node:
     name: 'node v4 - v6'

diff --git a/.github/workflows/node-7-9.yml b/.github/workflows/node-7-9.yml
@@ -30,13 +30,14 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
+          skip-ls-check: true
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   minors:
     needs: [matrix, latest]
@@ -55,13 +56,14 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
+          skip-ls-check: true
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   node:
     name: 'node v7 - v9'

diff --git a/.github/workflows/node-iojs.yml b/.github/workflows/node-iojs.yml
@@ -30,14 +30,14 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
           skip-ls-check: true
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   minors:
     needs: [matrix, latest]
@@ -56,14 +56,14 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
           skip-ls-check: true
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   node:
     name: 'io.js'

diff --git a/.github/workflows/node-zero.yml b/.github/workflows/node-zero.yml
@@ -31,15 +31,15 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
           cache-node-modules-key: node_modules-${{ github.workflow }}-${{ github.action }}-${{ github.run_id }}
           skip-ls-check: true
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   unstable:
     needs: [matrix, stable]
@@ -59,15 +59,15 @@ jobs:
           - test:shams:getownpropertysymbols
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ljharb/actions/node/install@main
         name: 'nvm install ${{ matrix.node-version }} && npm install'
         with:
           node-version: ${{ matrix.node-version }}
           cache-node-modules-key: node_modules-${{ github.workflow }}-${{ github.action }}-${{ github.run_id }}
           skip-ls-check: true
       - run: npm run ${{ matrix.command }}
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
 
   node:
     name: 'node 0.x'

diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,3 @@
+declare function hasToStringTag(): boolean;
+
+export = hasToStringTag;
diff --git a/index.js b/index.js
@@ -2,6 +2,7 @@
 
 var hasSymbols = require('has-symbols');
 
+/** @type {import('.')} */
 module.exports = function hasToStringTag() {
 	return hasSymbols() && typeof Symbol.toStringTag === 'symbol';
 };
diff --git a/package.json b/package.json
@@ -19,9 +19,22 @@
 	"description": "Determine if the JS environment has `Symbol.toStringTag` support. Supports spec, or shams.",
 	"license": "MIT",
 	"main": "index.js",
+	"types": "./index.d.ts",
 	"exports": {
-		".": "./index.js",
-		"./shams": "./shams.js",
+		".": [
+			{
+				"types": "./index.d.ts",
+				"default": "./index.js"
+			},
+			"./index.js"
+		],
+		"./shams": [
+			{
+				"types": "./shams.d.ts",
+				"default": "./shams.js"
+			},
+			"./shams.js"
+		],
 		"./package.json": "./package.json"
 	},
 	"scripts": {
@@ -59,6 +72,8 @@
 	],
 	"devDependencies": {
 		"@ljharb/eslint-config": "^21.1.0",
+		"@types/has-symbols": "^1.0.2",
+		"@types/tape": "^5.6.4",
 		"aud": "^2.0.4",
 		"auto-changelog": "^2.4.0",
 		"core-js": "^2.6.12",
@@ -69,7 +84,8 @@
 		"npmignore": "^0.3.1",
 		"nyc": "^10.3.2",
 		"safe-publish-latest": "^2.0.0",
-		"tape": "^5.7.4"
+		"tape": "^5.7.4",
+		"typescript": "next"
 	},
 	"engines": {
 		"node": ">= 0.4"

diff --git a/shams.d.ts b/shams.d.ts
@@ -0,0 +1,3 @@
+declare function hasToStringTagShams(): boolean;
+
+export = hasToStringTagShams;
diff --git a/shams.js b/shams.js
@@ -2,6 +2,7 @@
 
 var hasSymbols = require('has-symbols/shams');
 
+/** @type {import('.')} */
 module.exports = function hasToStringTagShams() {
 	return hasSymbols() && !!Symbol.toStringTag;
 };
diff --git a/test/shams/core-js.js b/test/shams/core-js.js
@@ -8,6 +8,7 @@ if (typeof Symbol === 'function' && typeof Symbol.toStringTag === 'symbol') {
 		t.equal(typeof Symbol.toStringTag, 'symbol');
 		t.end();
 	});
+	// @ts-expect-error CJS has top-level return
 	return;
 }
 
@@ -16,7 +17,9 @@ var hasSymbolToStringTag = require('../../shams');
 test('polyfilled Symbols', function (t) {
 	/* eslint-disable global-require */
 	t.equal(hasSymbolToStringTag(), false, 'hasSymbolToStringTag is false before polyfilling');
+	// @ts-expect-error no types defined
 	require('core-js/fn/symbol');
+	// @ts-expect-error no types defined
 	require('core-js/fn/symbol/to-string-tag');
 
 	require('../tests')(t);

diff --git a/test/shams/get-own-property-symbols.js b/test/shams/get-own-property-symbols.js
@@ -8,6 +8,7 @@ if (typeof Symbol === 'function' && typeof Symbol() === 'symbol') {
 		t.equal(typeof Symbol(), 'symbol');
 		t.end();
 	});
+	// @ts-expect-error CJS has top-level return
 	return;
 }
 
@@ -17,6 +18,7 @@ test('polyfilled Symbols', function (t) {
 	/* eslint-disable global-require */
 	t.equal(hasSymbolToStringTag(), false, 'hasSymbolToStringTag is false before polyfilling');
 
+	// @ts-expect-error no types defined
 	require('get-own-property-symbols');
 
 	require('../tests')(t);

diff --git a/test/tests.js b/test/tests.js
@@ -1,12 +1,13 @@
 'use strict';
 
 // eslint-disable-next-line consistent-return
-module.exports = function runSymbolTests(t) {
+module.exports = /** @type {(t: import('tape').Test) => void | false} */ function runSymbolTests(t) {
 	t.equal(typeof Symbol, 'function', 'global Symbol is a function');
 	t.ok(Symbol.toStringTag, 'Symbol.toStringTag exists');
 
 	if (typeof Symbol !== 'function' || !Symbol.toStringTag) { return false; }
 
+	/** @type {{ [Symbol.toStringTag]?: 'test'}} */
 	var obj = {};
 	obj[Symbol.toStringTag] = 'test';