fix: address security vulnerabilities and upgrade Nuxt to v3.17.2 (#49)

- Upgrade Nuxt from older version to ^3.17.2 to address security alerts
- Update all dependencies to latest versions for security patches
- Add ESLint and Prettier configuration for code quality
- Refactor module to use ES modules syntax
- Update Node.js and Yarn versions in .tool-versions
- Add unit tests for getGCLID function
- Update CI workflow with new Playwright and Node versions
- Improve code formatting and consistency across all files
- Update documentation (CODE_OF_CONDUCT.md, CONTRIBUTING.md)

Addresses Dependabot security alerts by upgrading vulnerable dependencies

Co-authored-by: Sadjow Leão <[email protected]>

Author: hakenprog

.eslintignore

@@ -0,0 +1,14 @@
+import prettierPlugin from 'eslint-plugin-prettier'
+import eslintConfig from './eslint.config.mjs'
+
+export default [
+  ...eslintConfig,
+  {
+    plugins: {
+      prettier: prettierPlugin,
+    },
+    rules: {
+      'prettier/prettier': 'error',
+    },
+  },
+]

.eslintprettier.config.js

@@ -0,0 +1,24 @@
+module.exports = {
+  root: true,
+  extends: ['@nuxt/eslint-config', 'plugin:prettier/recommended'],
+  rules: {
+    'prettier/prettier': 'error',
+    '@stylistic/quotes': ['error', 'single'],
+    '@stylistic/semi': ['error', 'never'],
+    '@stylistic/comma-dangle': ['error', 'always-multiline'],
+    '@stylistic/operator-linebreak': ['error', 'before'],
+    '@stylistic/member-delimiter-style': [
+      'error',
+      {
+        multiline: {
+          delimiter: 'none',
+          requireLast: false,
+        },
+        singleline: {
+          delimiter: 'comma',
+          requireLast: false,
+        },
+      },
+    ],
+  },
+}

.eslintrc.prettier.js

@@ -7,11 +7,11 @@ jobs:
     timeout-minutes: 10
     runs-on: ubuntu-latest
     container:
-      image: mcr.microsoft.com/playwright:v1.39.0-jammy
+      image: mcr.microsoft.com/playwright:v1.52.0-jammy
 
     strategy:
       matrix:
-        node-version: [18, 20]
+        node-version: [20, 22]
 
     steps:
       - name: Checkout code
@@ -26,7 +26,7 @@ jobs:
         id: cache-npm
         uses: actions/cache@v3
         with:
-          path: "**/node_modules"
+          path: '**/node_modules'
           key: ${{ runner.os }}-node-${{ matrix.node-version }}-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
             ${{ runner.os }}-node-${{ matrix.node-version }}-

.github/workflows/main.yml

@@ -0,0 +1,22 @@
+# dependencies
+node_modules
+.nuxt
+.output
+dist
+
+# logs
+*.log
+
+# coverage files
+coverage
+.nyc_output
+
+# OSX
+.DS_Store
+
+# Editors
+.idea
+.vscode
+
+# git
+.git 

.prettierignore

@@ -0,0 +1,12 @@
+{
+  "singleQuote": true,
+  "quoteProps": "as-needed",
+  "semi": false,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false
+}

.prettierrc

@@ -0,0 +1,2 @@
+nodejs 22.15.1
+yarn 1.22.19

.tool-versions

@@ -45,8 +45,8 @@ npm install --save-dev nuxt-utm
 
 ```js
 export default defineNuxtConfig({
-  modules: ["nuxt-utm"],
-});
+  modules: ['nuxt-utm'],
+})
 ```
 
 That's it! You can now use Nuxt UTM in your Nuxt app ✨
@@ -57,7 +57,7 @@ You can use `useNuxtUTM` composable to access the UTM object:
 
 ```vue
 <script setup>
-const utm = useNuxtUTM();
+const utm = useNuxtUTM()
 </script>
 ```
 
@@ -67,42 +67,41 @@ Alternatively, you can get the UTM information through the Nuxt App with the fol
 
 ```vue
 <script setup>
-import { useNuxtApp } from "nuxt/app";
-const { $utm } = useNuxtApp();
+import { useNuxtApp } from 'nuxt/app'
+const { $utm } = useNuxtApp()
 </script>
 ```
 
 Regardless of the option you choose to use the module, the `utm' object will contain an array of UTM parameters collected for use. Each element in the array represents a set of UTM parameters collected from a URL visit, and is structured as follows
 
-```js
+```json
 [
   {
-    timestamp: "2023-11-02T10:11:17.219Z", // Timestamp of the URL visit
-    utmParams: {
-      utm_source: "test_source",
-      utm_medium: "test_medium",
-      utm_campaign: "test_campaign",
-      utm_term: "test_term",
-      utm_content: "test_content",
-    },
-    additionalInfo: {
-      referrer: "http://referrer.url", // Referrer URL
-      userAgent: "User-Agent String", // User-Agent string of the browser
-      language: "en-GB", // Language setting of the browser
-      landingPageUrl: "http://landingpage.url", // The URL of the page the user landed on
-      screen: {
-        width: 1728,
-        height: 1117,
-      },
+    "timestamp": "2023-11-02T10:11:17.219Z",
+    "utmParams": {
+      "utm_source": "test_source",
+      "utm_medium": "test_medium",
+      "utm_campaign": "test_campaign",
+      "utm_term": "test_term",
+      "utm_content": "test_content"
     },
-    sessionId: "beai1gx7dg",
-    gclidParams: {
-      gclid: "CjklsefawEFRfeafads",
-      gad_source: "1",
+    "additionalInfo": {
+      "referrer": "http://referrer.url",
+      "userAgent": "User-Agent String",
+      "language": "en-GB",
+      "landingPageUrl": "http://landingpage.url",
+      "screen": {
+        "width": 1728,
+        "height": 1117
+      }
     },
-  }, // the first item in this array is the most recent
-  // ... old items
-];
+    "sessionId": "beai1gx7dg",
+    "gclidParams": {
+      "gclid": "CjklsefawEFRfeafads",
+      "gad_source": "1"
+    }
+  }
+]
 ```
 
 In the `$utm` array, each entry provides a `timestamp` indicating when the UTM parameters were collected, the `utmParams` object containing the UTM parameters, `additionalInfo` object with more context about the visit, and a `sessionId` to differentiate visits in different sessions.

README.md

@@ -1,10 +1,12 @@
 # Code of conduct
 
 ## Purpose
+
 The primary goal of this Code of Conduct is to enable an open and welcoming environment. We pledge to making participation in our project a harassment-free experience for everyone, regardless of gender, sexual
 orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
 
 ## General recommendations
+
 Examples of behavior that contributes to creating a positive environment include:
 
 - Using welcoming and inclusive language
@@ -22,14 +24,17 @@ Examples of unacceptable behavior by participants include:
 - Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Maintainer responsibilities
+
 Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
 
 ## Scope
+
 This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
 
 ## Enforcement
+
 Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

docs/CODE_OF_CONDUCT.md

@@ -1,4 +1,3 @@
-
 Thank you for your interest in contributing to this Stack Builders' library. To contribute, please take our [Code of Conduct](CODE_OF_CONDUCT.md) into account, along with the following recommendations:
 
 - When submitting contributions to this repository, please make sure to discuss with the maintainer(s) the change you want to make. You can do this through an issue, or by sending an email to [[email protected]](mailto:[email protected])
@@ -10,4 +9,5 @@ Thank you for your interest in contributing to this Stack Builders' library. To
 - Once you get an approval from any of the maintainers, please merge your Pull Request. Keep in mind that some of our Stack Builders repositories use CI/CD pipelines, so you will need to pass all of the required checks before merging.
 
 ## Getting help
+
 Contact any of our current maintainers, or send us an email at [[email protected]](mailto:[email protected]) for more information. Thank you for contributing!