Document update (#109)

* tests added

* refined test data

* Delete cyoutput.json

* Delete output.json

* Delete src/monthlySummaryMethods/buildSummary.test.js.new

* Delete test-results/output.json

* Update package.json

Author: petermsouzajr

.eslintrc.cjs

@@ -6,6 +6,7 @@ module.exports = {
     commonjs: true,
   },
   extends: 'eslint:recommended',
+  plugins: ['jsdoc'],
   parserOptions: {
     ecmaVersion: 2021,
     sourceType: 'module',
@@ -18,5 +19,65 @@ module.exports = {
     'no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
     'no-console': 'off',
     'prefer-const': 'error',
+    // JSDoc specific rules
+    'jsdoc/require-jsdoc': [
+      'warn',
+      {
+        publicOnly: true,
+        require: {
+          FunctionDeclaration: true,
+          MethodDefinition: true,
+          ClassDeclaration: true,
+        },
+      },
+    ],
+    'jsdoc/require-param': 'warn',
+    'jsdoc/require-returns': 'warn',
+    'jsdoc/require-returns-type': 'warn',
+    'jsdoc/valid-types': 'warn',
+    // Disable TypeScript-specific rules
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-unused-vars': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-empty-interface': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/ban-types': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/no-empty-interface': 'off',
+    '@typescript-eslint/no-inferrable-types': 'off',
+    '@typescript-eslint/no-namespace': 'off',
+    '@typescript-eslint/no-this-alias': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/prefer-as-const': 'off',
+    '@typescript-eslint/prefer-namespace-keyword': 'off',
+    '@typescript-eslint/triple-slash-reference': 'off',
+    '@typescript-eslint/type-annotation-spacing': 'off',
+    '@typescript-eslint/unified-signatures': 'off',
+    '@typescript-eslint/no-floating-promises': 'off',
+    '@typescript-eslint/no-misused-promises': 'off',
+    '@typescript-eslint/no-unnecessary-type-assertion': 'off',
+    '@typescript-eslint/no-unnecessary-type-constraint': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-return': 'off',
+    '@typescript-eslint/restrict-plus-operands': 'off',
+    '@typescript-eslint/restrict-template-expressions': 'off',
+    '@typescript-eslint/unbound-method': 'off',
   },
+  overrides: [
+    {
+      files: ['*.js'],
+      rules: {
+        // Additional rules specific to .js files
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+      },
+    },
+  ],
 };

README.md

@@ -23,7 +23,7 @@ Our package bridges Cypress and Playwright test runs with Google Sheets or CSV,
    - [Column: Category](#column-category)
    - [Column: Manual Case](#column-manual-case)
    - ['The Works'](#the-works)
-6. [Cypress-Grep Integration](#cypressgrep-integration)
+6. [cypress/grep Integration](#cypressgrep-integration)
 7. [CI/CD](#cicd)
    - [GitHub](#github-actions-example)
    - [GitLab](#gitlab-ci-example)
@@ -272,7 +272,8 @@ All commands require that test suite result data is present, in this example, th
   - This command processes the data from the test results and create a detailed report.
   - A new Sheet Tab will be created with the current day's title (e.g., `Mar 24, 2024`), to which this detailed report will be written.
   - If the Sheet has Tabs for the previous month (e.g., current month is April and sheet tabs exist for `Mar 24, 2024`, `Mar 25, 2024`), then a monthly summary will be generated with that previous month's data (`Summary Mar 2024`).
-  - The report will fail if test result data is not present in JSON format.
+  - If you have activated the Weekly Summary feature, and the Sheet has Tabs for the previous week, a weekly summary will be generated with that week's data.
+  - The reports will fail if test result data is not present in JSON format.
   - Duplicate Sheet Tabs are not created by defualt, to create a duplicate Tab, use the flag `--duplicate`.
 
 - **To run the daily report only**
@@ -298,7 +299,7 @@ All commands require that test suite result data is present, in this example, th
 - Use the base commands with the optional flag `--duplicate`
   - `npx qa-shadow-report [framework] --duplicate`
   - `npx qa-shadow-report [framework] todays-report --duplicate`
-  - Monthly summary dupliactes must be created directly, using the command `npx qa-shadow-report [framework] monthly-summary`.
+  - Monthly summary dupliactes must be created directly, using the command `npx qa-shadow-report [framework] monthly-summary --duplicate`.
 
 ### Quick Command Reference
 
@@ -511,7 +512,7 @@ module.exports = {
 
 ## cypress/grep Integration
 
-To enhance your testing workflow and leverage the team name, test type, and test category annotations you've included in your test titles, we recommend integrating the [`cypress-grep`](https://www.npmjs.com/package/@cypress/grep) plugin.
+To enhance your testing workflow and leverage the team name, test type, and test category annotations you've included in your test titles, we recommend integrating the [`cypress/grep`](https://www.npmjs.com/package/@cypress/grep) plugin.
 
 ### Benefits of Using cypress/grep
 
@@ -543,7 +544,7 @@ By integrating `cypress/grep`, you can run subsets of tests based on your annota
 
 ### CI/CD
 
-This package is best suited for automated nightly runs, enabling teams to efficiently monitor project status and collaborate on test results every morning.
+This package is best suited for automated nightly runs where the daily report can help individual contributors or curious supervisors who need immediate and up-to-date insights. The weekly report is great for weekly meetings, providing a short-term summary of the previous week's test results. The monthly report offers a high-level overview, highlighting trends for QA managers or responsible parties to track long-term progress and performance.
 
 **Integrating Google Sheets Credentials with CI/CD:**