fix(tests): add test to verify that .npmrc files are covered

src/logic/__test_assets__/example-best-practices-repo/src/practices/npmrc/best-practice/.npmrc

@@ -0,0 +1,3 @@
+engine-strict=true
+save-exact=true
+message=%s 🎉

src/logic/__test_assets__/example-best-practices-repo/src/useCases.yml

@@ -12,3 +12,4 @@ use-cases:
       - dates-and-times
       - serverless
       - terraform
+      - npmrc

src/logic/__test_assets__/example-project-fails-npmrc-practice/package.json

@@ -0,0 +1 @@
+{}

src/logic/__test_assets__/example-project-fails-npmrc-practice/readme.md

@@ -0,0 +1 @@
+this project should fail because the .npmrc file is not defined

src/logic/usage/evaluate/__snapshots__/evaluateProjectAgainstPracticeDeclaration.integration.test.ts.snap

@@ -4730,3 +4730,55 @@ exports[`evaluteProjectAgainstPracticeDeclaration should ignore the "node_module
   },
 ]
 `;
+
+exports[`evaluteProjectAgainstPracticeDeclaration should include the ".npmrc" file when evaluating glob paths 1`] = `
+[
+  FilePracticeEvaluation {
+    "checks": [
+      FileCheckEvaluation {
+        "context": FileCheckContext {
+          "declaredFileContents": "engine-strict=true
+save-exact=true
+message=%s 🎉
+",
+          "getProjectRootDirectory": [Function],
+          "projectPractices": [],
+          "projectVariables": {},
+          "relativeFilePath": ".npmrc",
+          "required": true,
+        },
+        "fix": [Function],
+        "path": ".npmrc",
+        "practiceRef": "npmrc.best-practice",
+        "purpose": "BEST_PRACTICE",
+        "reason": "- Expected file to exist
++ Received file does not exist",
+        "required": true,
+        "result": "FAIL",
+        "type": "EQUALS",
+      },
+    ],
+    "path": ".npmrc",
+    "practice": PracticeDeclaration {
+      "badPractices": [],
+      "bestPractice": ProjectCheckDeclaration {
+        "checks": [
+          FileCheckDeclaration {
+            "check": [Function],
+            "contents": [Function],
+            "fix": [Function],
+            "pathGlob": ".npmrc",
+            "purpose": "BEST_PRACTICE",
+            "required": true,
+            "type": "EQUALS",
+          },
+        ],
+        "name": "npmrc",
+        "readme": null,
+      },
+      "name": "npmrc",
+    },
+    "result": "FAIL",
+  },
+]
+`;

src/logic/usage/evaluate/evaluateProjectAgainstPracticeDeclaration.integration.test.ts

@@ -537,4 +537,62 @@ describe('evaluteProjectAgainstPracticeDeclaration', () => {
     // now just save an example of the results
     expect(evaluations).toMatchSnapshot();
   });
+
+  it.only('should include the ".npmrc" file when evaluating glob paths', async () => {
+    // lookup a practice
+    const declarations = await readDeclarePracticesConfig({
+      configPath: `${testAssetsDirectoryPath}/example-best-practices-repo/declapract.declare.yml`,
+    });
+    const practice = declarations.practices.find(
+      (thisPractice) => thisPractice.name === 'npmrc',
+    );
+    if (!practice) fail('should have found the practice');
+
+    // sanity check the practice we'll be using
+    console.log(practice);
+    expect(practice.bestPractice).toBeDefined(); // check that our expectations for the test are met
+
+    // now evaluate it
+    const projectRootDirectory = `${testAssetsDirectoryPath}/example-project-fails-npmrc-practice`;
+    const project = new ProjectCheckContext({
+      getProjectRootDirectory: () => projectRootDirectory,
+      projectVariables: {},
+      projectPractices: [],
+    });
+    const evaluations = await evaluteProjectAgainstPracticeDeclaration({
+      practice,
+      project,
+    });
+
+    // check that the evaluation matches what we expect
+    expect(
+      evaluations.filter((file) => file.result === FileEvaluationResult.FAIL)
+        .length,
+    ).toEqual(1);
+    expect(
+      evaluations.filter((file) => file.result === FileEvaluationResult.PASS)
+        .length,
+    ).toEqual(0);
+
+    // sanity check a couple of important examples
+    expect(
+      evaluations.find((file) => file.path === '.npmrc'), // should  have found this path
+    ).toBeDefined(); // should have found it because `.declapract` directory should be ignored
+
+    expect(
+      evaluations.find((file) => file.path === '.npmrc'), // should have required it to exist
+    ).toMatchObject({
+      result: FileEvaluationResult.FAIL,
+      checks: expect.arrayContaining([
+        expect.objectContaining({
+          result: FileEvaluationResult.FAIL,
+          purpose: FileCheckPurpose.BEST_PRACTICE,
+          type: FileCheckType.EQUALS,
+        }),
+      ]),
+    });
+
+    // now just save an example of the results
+    expect(evaluations).toMatchSnapshot();
+  });
 });