glin-profanity 0.0.1

package/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env", "@babel/preset-react", "@babel/preset-typescript"]
+}

package/.eslintrc.json

@@ -0,0 +1,31 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "extends": [
+      "eslint:recommended",
+      "plugin:react/recommended",
+      "plugin:@typescript-eslint/recommended",
+      "plugin:prettier/recommended"
+    ],
+    "plugins": ["react", "@typescript-eslint"],
+    "env": {
+      "browser": true,
+      "node": true,
+      "es6": true
+    },
+    "parserOptions": {
+      "ecmaFeatures": {
+        "jsx": true
+      },
+      "ecmaVersion": 2020,
+      "sourceType": "module"
+    },
+    "settings": {
+      "react": {
+        "version": "detect"
+      }
+    },
+    "rules": {
+      "prettier/prettier": "error"
+    }
+  }
+  

package/.gitattributes

@@ -0,0 +1 @@
+* text=auto

package/.github/workflows/dependency-review.yml

@@ -0,0 +1,39 @@
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request,
+# surfacing known-vulnerable versions of the packages declared or updated in the PR.
+# Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable
+# packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
+name: 'Dependency review'
+on:
+  pull_request:
+    branches: [ "develop" ]
+
+# If using a dependency submission action in this workflow this permission will need to be set to:
+#
+# permissions:
+#   contents: write
+#
+# https://docs.github.com/en/enterprise-cloud@latest/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api
+permissions:
+  contents: read
+  # Write permissions for pull-requests are required for using the `comment-summary-in-pr` option, comment out if you aren't using this option
+  pull-requests: write
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+        # Commonly enabled options, see https://github.com/actions/dependency-review-action#configuration-options for all available options.
+        with:
+          comment-summary-in-pr: always
+        #   fail-on-severity: moderate
+        #   deny-licenses: GPL-1.0-or-later, LGPL-2.0-or-later
+        #   retry-on-snapshot-warnings: true

package/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish to NPM
+
+on:
+  push:
+    branches:
+      - release
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: '18'
+        registry-url: 'https://registry.npmjs.org'
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Build project
+      run: npm run build
+
+    - name: Publish to npm
+      run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.husky/commit-msg

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ${1}
+npx --no-install commitlint --edit "$1"

package/.husky/post-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+git push

package/.husky/pre-commit

@@ -0,0 +1,5 @@
+
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn lint-staged 

package/.nvmrc

@@ -0,0 +1 @@
+v18.20.1

package/.prettierignore

@@ -0,0 +1,13 @@
+# Files to ingore prettier to format
+
+/dist
+/build
+
+# Eslint files
+.eslintignore
+.eslintrc.js
+
+#commit files
+changelog.config.js
+commitlint.config.js
+/.husky

package/.prettierrc

@@ -0,0 +1,15 @@
+{
+  "singleQuote": true,
+  "doubleQuote": true,
+  "useTabs": false,
+  "overrides": [
+    {
+      "files": "*.yaml",
+      "options": {
+        "tadWidth": 2,
+        "printWidth": 40,
+        "singleQuote": true
+      }
+    }
+  ]
+}

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,80 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others’ private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [support@glincker.com]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).
+
+[homepage]: https://www.contributor-covenant.org

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,136 @@
+# Glin Profanity
+Glin-Profanity is a lightweight and efficient npm package designed to detect and filter profane language in text inputs across multiple languages. Whether you’re building a chat application, a comment section, or any platform where user-generated content is involved, Glin-Profanity helps you maintain a clean and respectful environment.
+
+## Installation
+
+To install Glin-Profanity, use npm:
+
+```bash
+npm install glin-profanity
+```
+
+## Usage
+
+### Basic Usage
+
+Here's a simple example of how to use Glin-Profanity in a React application:
+
+```typescript
+import React, { useState } from 'react';
+import { useProfanityChecker, Language } from 'glin-profanity';
+
+const App: React.FC = () => {
+  const [text, setText] = useState('');
+  const [checkAllLanguages, setCheckAllLanguages] = useState(false);
+  const { result, checkText } = useProfanityChecker(
+    checkAllLanguages ? { allLanguages: true } : { languages: ['english', 'french'] }
+  );
+
+  const handleChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+    setText(e.target.value);
+  };
+
+  const handleCheck = () => {
+    checkText(text);
+  };
+
+  return (
+    <div>
+      <h1>Welcome to Glin-Profanity</h1>
+      <input type="text" value={text} onChange={handleChange} />
+      <button onClick={handleCheck}>Check Profanity</button>
+      <div>
+        <label>
+          <input
+            type="checkbox"
+            checked={checkAllLanguages}
+            onChange={(e) => setCheckAllLanguages(e.target.checked)}
+          />
+          Check All Languages
+        </label>
+      </div>
+      {result && (
+        <div>
+          <p>Contains Profanity: {result.containsProfanity ? 'Yes' : 'No'}</p>
+          {result.containsProfanity && (
+            <p>Profane Words: {result.profaneWords.join(', ')}</p>
+          )}
+        </div>
+      )}
+    </div>
+  );
+};
+
+export default App;
+```
+
+## API
+
+### `Filter` Class
+
+#### Constructor
+
+```typescript
+new Filter(config?: { languages?: Language[]; allLanguages?: boolean });
+```
+
+- `config`: An optional configuration object.
+  - `languages`: An array of languages to check for profanities.
+  - `allLanguages`: A boolean indicating whether to check for all languages.
+
+#### Methods
+
+##### `isProfane`
+
+Checks if a given text contains profanities.
+
+```typescript
+isProfane(value: string): boolean;
+```
+
+- `value`: The text to check.
+- Returns: `boolean` - `true` if the text contains profanities, `false` otherwise.
+
+##### `checkProfanity`
+
+Returns details about profanities found in the text.
+
+```typescript
+checkProfanity(text: string): CheckProfanityResult;
+```
+
+- `text`: The text to check.
+- Returns: `CheckProfanityResult`
+  - `containsProfanity`: `boolean` - `true` if the text contains profanities, `false` otherwise.
+  - `profaneWords`: `string[]` - An array of profane words found in the text.
+
+### `useProfanityChecker` Hook
+
+A custom React hook for using the profanity checker.
+
+#### Parameters
+
+- `config`: An optional configuration object.
+  - `languages`: An array of languages to check for profanities.
+  - `allLanguages`: A boolean indicating whether to check for all languages.
+
+#### Return Value
+
+- `result`: The result of the profanity check.
+- `checkText`: A function to check a given text for profanities.
+
+```typescript
+const { result, checkText } = useProfanityChecker(config);
+```
+
+## License
+
+This software is also available under the GLINCKER LLC proprietary license. The proprietary license allows for use, modification, and distribution of the software with certain restrictions and conditions as set forth by GLINCKER LLC.
+
+You are free to use this software for reference and educational purposes. However, any commercial use, distribution, or modification outside the terms of the MIT License requires explicit permission from GLINCKER LLC. 
+
+By using the software in any form, you agree to adhere to the terms of both the MIT License and the GLINCKER LLC proprietary license, where applicable. If there is any conflict between the terms of the MIT License and the GLINCKER LLC proprietary license, the terms of the GLINCKER LLC proprietary license shall prevail.
+
+### MIT License
+
+GLIN PROFANITY is [MIT licensed](./LICENSE).

package/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+We release patches for security vulnerabilities. Which versions are eligible for security updates?
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x     | :white_check_mark: |
+| < 1.0   | :x:                |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, please open an issue or contact us directly at [gdsks@glincker.com]. We take all security vulnerabilities seriously and will respond promptly to address the issue.

package/changelog.config.cjs

@@ -0,0 +1,89 @@
+/* eslint-disable no-undef */
+module.exports = {
+    disableEmoji: false,
+    format: '{type}{scope}: {emoji}{subject}',
+    list: [
+      'test',
+      'feat',
+      'fix',
+      'chore',
+      'docs',
+      'refactor',
+      'style',
+      'ci',
+      'perf',
+    ],
+    maxMessageLength: 64,
+    minMessageLength: 3,
+    questions: [
+      'type',
+      'scope',
+      'subject',
+      'body',
+      'breaking',
+      'issues',
+      'lerna',
+    ],
+    scopes: [],
+    types: {
+      chore: {
+        description: 'Build process or auxiliary tool changes',
+        emoji: '🤖',
+        value: 'chore',
+      },
+      ci: {
+        description: 'CI related changes',
+        emoji: '🎡',
+        value: 'ci',
+      },
+      docs: {
+        description: 'Documentation only changes',
+        emoji: '✏️',
+        value: 'docs',
+      },
+      feat: {
+        description: 'A new feature',
+        emoji: '🎸',
+        value: 'feat',
+      },
+      fix: {
+        description: 'A bug fix',
+        emoji: '🐛',
+        value: 'fix',
+      },
+      perf: {
+        description: 'A code change that improves performance',
+        emoji: '⚡️',
+        value: 'perf',
+      },
+      refactor: {
+        description: 'A code change that neither fixes a bug or adds a feature',
+        emoji: '💡',
+        value: 'refactor',
+      },
+      release: {
+        description: 'Create a release commit',
+        emoji: '🏹',
+        value: 'release',
+      },
+      style: {
+        description: 'Markup, white-space, formatting, missing semi-colons...',
+        emoji: '💄',
+        value: 'style',
+      },
+      test: {
+        description: 'Adding missing tests',
+        emoji: '💍',
+        value: 'test',
+      },
+      messages: {
+        type: "Select the type of change that you're committing:",
+        customScope: 'Select the scope this component affects:',
+        subject: 'Write a short, imperative mood description of the change:\n',
+        body: 'Provide a longer description of the change:\n ',
+        breaking: 'List any breaking changes:\n',
+        footer: 'Issues this commit closes, e.g #123:',
+        confirmCommit: 'The packages that this commit has affected\n',
+      },
+    },
+  };

package/commitlint.config.cjs

@@ -0,0 +1,138 @@
+/* eslint-disable linebreak-style */
+/* eslint-disable no-undef */
+
+module.exports = {
+    extends: ['@commitlint/config-conventional'],
+    rules: {
+      'body-leading-blank': [1, 'always'],
+      'body-max-line-length': [2, 'always', 100],
+      'footer-leading-blank': [1, 'always'],
+      'footer-max-line-length': [2, 'always', 100],
+      'header-max-length': [2, 'always', 100],
+      'subject-case': [
+        2,
+        'never',
+        ['sentence-case', 'start-case', 'pascal-case', 'upper-case'],
+      ],
+      'subject-empty': [2, 'never'],
+      'subject-full-stop': [2, 'never', '.'],
+      'type-case': [2, 'always', 'lower-case'],
+      'type-empty': [2, 'never'],
+      'type-enum': [
+        2,
+        'always',
+        [
+          'build',
+          'chore',
+          'ci',
+          'docs',
+          'feat',
+          'fix',
+          'perf',
+          'refactor',
+          'revert',
+          'style',
+          'test',
+        ],
+      ],
+    },
+    prompt: {
+      questions: {
+        type: {
+          description: "Select the type of change that you're committing",
+          enum: {
+            feat: {
+              description: 'A new feature',
+              title: 'Features',
+              emoji: '✨',
+            },
+            fix: {
+              description: 'A bug fix',
+              title: 'Bug Fixes',
+              emoji: '🐛',
+            },
+            docs: {
+              description: 'Documentation only changes',
+              title: 'Documentation',
+              emoji: '📚',
+            },
+            style: {
+              description:
+                'Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)',
+              title: 'Styles',
+              emoji: '💎',
+            },
+            refactor: {
+              description:
+                'A code change that neither fixes a bug nor adds a feature',
+              title: 'Code Refactoring',
+              emoji: '📦',
+            },
+            perf: {
+              description: 'A code change that improves performance',
+              title: 'Performance Improvements',
+              emoji: '🚀',
+            },
+            test: {
+              description: 'Adding missing tests or correcting existing tests',
+              title: 'Tests',
+              emoji: '🚨',
+            },
+            build: {
+              description:
+                'Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)',
+              title: 'Builds',
+              emoji: '🛠',
+            },
+            ci: {
+              description:
+                'Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)',
+              title: 'Continuous Integrations',
+              emoji: '⚙️',
+            },
+            chore: {
+              description: "Other changes that don't modify src or test files",
+              title: 'Chores',
+              emoji: '♻️',
+            },
+            revert: {
+              description: 'Reverts a previous commit',
+              title: 'Reverts',
+              emoji: '🗑',
+            },
+          },
+        },
+        scope: {
+          description:
+            'What is the scope of this change (e.g. component or file name)',
+        },
+        subject: {
+          description:
+            'Write a short, imperative tense description of the change',
+        },
+        body: {
+          description: 'Provide a longer description of the change',
+        },
+        isBreaking: {
+          description: 'Are there any breaking changes?',
+        },
+        breakingBody: {
+          description:
+            'A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself',
+        },
+        breaking: {
+          description: 'Describe the breaking changes',
+        },
+        isIssueAffected: {
+          description: 'Does this change affect any open issues?',
+        },
+        issuesBody: {
+          description:
+            'If issues are closed, the commit requires a body. Please enter a longer description of the commit itself',
+        },
+        issues: {
+          description: 'Add issue references (e.g. "fix #123", "re #123".)',
+        },
+      },
+    },
+  };