Fixed templating and some linting

JoshuaKGoldberg · May 22, 2023 · 1b98b8e · 1b98b8e
1 parent c901483
commit 1b98b8e
Show file tree

Hide file tree

Showing 15 changed files with 22 additions and 107 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -15,7 +15,7 @@
 	"contributorsSortAlphabetically": true,
 	"files": ["README.md"],
 	"imageSize": 100,
-	"projectName": "template-typescript-node-package",
+	"projectName": "console-fail-test",
 	"projectOwner": "JoshuaKGoldberg",
 	"repoHost": "https://github.com",
 	"repoType": "github"

diff --git a/.github/DEVELOPMENT.md b/.github/DEVELOPMENT.md
@@ -59,9 +59,6 @@ Add the `--coverage` flag to compute test coverage and place reports in the `cov
 pnpm run test --coverage
 ```
 
-Note that [console-fail-test](https://github.com/JoshuaKGoldberg/console-fail-test) is enabled for all test runs.
-Calls to `console.log`, `console.warn`, and other console methods will cause a test to fail.
-
 ### Debugging Tests
 
 This repository includes a [VS Code launch configuration](https://code.visualstudio.com/docs/editor/debugging) for debugging unit tests.

diff --git a/.github/ISSUE_TEMPLATE/01-bug.yml b/.github/ISSUE_TEMPLATE/01-bug.yml
@@ -7,7 +7,7 @@ body:
           required: true
         - label: I have pulled the latest `main` branch of the repository.
           required: true
-        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aissue) and found none that matched my issue.
+        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/console-fail-test/issues?q=is%3Aissue) and found none that matched my issue.
           required: true
     type: checkboxes
   - attributes:

diff --git a/.github/ISSUE_TEMPLATE/02-documentation.yml b/.github/ISSUE_TEMPLATE/02-documentation.yml
@@ -5,7 +5,7 @@ body:
       options:
         - label: I have pulled the latest `main` branch of the repository.
           required: true
-        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aissue) and found none that matched my issue.
+        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/console-fail-test/issues?q=is%3Aissue) and found none that matched my issue.
           required: true
     type: checkboxes
   - attributes:

diff --git a/.github/ISSUE_TEMPLATE/03-feature.yml b/.github/ISSUE_TEMPLATE/03-feature.yml
@@ -7,7 +7,7 @@ body:
           required: true
         - label: I have pulled the latest `main` branch of the repository.
           required: true
-        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aissue) and found none that matched my issue.
+        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/console-fail-test/issues?q=is%3Aissue) and found none that matched my issue.
           required: true
     type: checkboxes
   - attributes:

diff --git a/.github/ISSUE_TEMPLATE/04-tooling.yml b/.github/ISSUE_TEMPLATE/04-tooling.yml
@@ -7,7 +7,7 @@ body:
           required: true
         - label: I have pulled the latest `main` branch of the repository.
           required: true
-        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aissue) and found none that matched my issue.
+        - label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/console-fail-test/issues?q=is%3Aissue) and found none that matched my issue.
           required: true
     type: checkboxes
   - attributes:

diff --git a/.github/workflows/post-release.yml b/.github/workflows/post-release.yml
@@ -14,8 +14,8 @@ jobs:
 
             The release is available on:
 
-            * [GitHub releases](https://github.com/JoshuaKGoldberg/template-typescript-node-package/releases/tag/{release_tag})
-            * [npm package (@latest dist-tag)](https://www.npmjs.com/package/template-typescript-node-package/v/${{ env.npm_version }})
+            * [GitHub releases](https://github.com/JoshuaKGoldberg/console-fail-test/releases/tag/{release_tag})
+            * [npm package (@latest dist-tag)](https://www.npmjs.com/package/console-fail-test/v/${{ env.npm_version }})
 
             Cheers! 📦🚀
 

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -23,7 +23,7 @@ jobs:
           script: |
             try {
               await github.request(
-                `DELETE /repos/JoshuaKGoldberg/template-typescript-node-package/branches/main/protection`,
+                `DELETE /repos/JoshuaKGoldberg/console-fail-test/branches/main/protection`,
               );
             } catch (error) {
               if (!error.message?.includes?.("Branch not protected")) {
@@ -44,7 +44,7 @@ jobs:
           github-token: ${{ secrets.ACCESS_TOKEN }}
           script: |
             github.request(
-              `PUT /repos/JoshuaKGoldberg/template-typescript-node-package/branches/main/protection`,
+              `PUT /repos/JoshuaKGoldberg/console-fail-test/branches/main/protection`,
               {
                 allow_deletions: false,
                 allow_force_pushes: true,
@@ -54,7 +54,7 @@ jobs:
                 branch: "main",
                 enforce_admins: false,
                 owner: "JoshuaKGoldberg",
-                repo: "template-typescript-node-package",
+                repo: "console-fail-test",
                 required_conversation_resolution: true,
                 required_linear_history: false,
                 required_pull_request_reviews: null,

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
diff --git a/README.md b/README.md
@@ -329,7 +329,8 @@ require("console-fail-test").cft({
 
 ## Ignoring `console` methods
 
-By default, `console-fail-test` will error on _any_ called `console` method. If you'd like allow certain methods, pass a `console` object to the `cft` API when you set it up:
+By default, `console-fail-test` will error on _any_ called `console` method.
+If you'd like allow certain methods, pass a `console` object to the `cft` API when you set it up:
 
 ```js
 require("console-fail-test").cft({
@@ -384,4 +385,4 @@ See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 <!-- spellchecker: enable -->
 
-> 💙 This package is based on [@JoshuaKGoldberg](https://github.com/JoshuaKGoldberg)'s [template-typescript-node-package](https://github.com/JoshuaKGoldberg/template-typescript-node-package).`,
+> 💙 This package is based on [@JoshuaKGoldberg](https://github.com/JoshuaKGoldberg)'s [template-typescript-node-package](https://github.com/JoshuaKGoldberg/template-typescript-node-package).,
diff --git a/docs/Development.md b/docs/Development.md
@@ -71,7 +71,8 @@ The `TestFramework` object potentially returned by a test framework selector inc
 The `SpyFactorySelector` function potentially returned by a test framework selector will be used by [`cft.ts`](../src/cft.ts) to create method spies on the console.
 It receives as parameters:
 
-1. `container`: An object whose method is to be spied on. This will practically always be `console`.
+1. `container`: An object whose method is to be spied on.
+   This will practically always be `console`.
    - Note that in future versions of console-fail-test, this may expand to include other objects.
 2. `methodName`: The key of the method to spy on, such as `"log"`.
 

diff --git a/package.json b/package.json
@@ -1,5 +1,6 @@
 {
 	"name": "console-fail-test",
+	"version": "0.3.0",
 	"description": "Gently fails test runs if the console was used during them.",
 	"repository": {
 		"type": "git",
@@ -40,7 +41,6 @@
 		"@typescript-eslint/eslint-plugin": "^5.59.6",
 		"@typescript-eslint/parser": "^5.59.6",
 		"@vitest/coverage-istanbul": "^0.31.1",
-		"console-fail-test": "^0.2.3",
 		"cspell": "^6.31.1",
 		"eslint": "^8.41.0",
 		"eslint-config-prettier": "^8.8.0",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/environments/testEnvironmentTypes.ts b/src/environments/testEnvironmentTypes.ts
@@ -5,7 +5,7 @@ export type TestFrameworkSelector = (
 	request: CftRequest
 ) => TestFramework | undefined;
 
-export interface TestFramework {
+interface TestFramework {
 	/**
 	 * Adds a callback to be called after each test.
 	 * @param callback - Called after each test.
@@ -27,11 +27,11 @@ export interface TestFramework {
 	mapSpyCalls?: (call: SpyCallsAndName) => SpyCallArgs[];
 }
 
-export interface TestAfterHooks {
+interface TestAfterHooks {
 	reportComplaint?: (complaint: TestComplaint) => void;
 }
 
-export interface SpyCallsAndName {
+interface SpyCallsAndName {
 	methodCalls: SpyCallArgs[];
 	methodName: string;
 }

diff --git a/vitest.config.ts b/vitest.config.ts
@@ -11,6 +11,5 @@ export default defineConfig({
 			reporter: ["html", "lcov"],
 		},
 		exclude: ["lib", "node_modules"],
-		setupFiles: ["console-fail-test/setup"],
 	},
 });