Merge pull request #4 from brittni-and-the-polar-bear/development-main

Merge to main to test first release

.eslintrc

@@ -0,0 +1,64 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": [
+      "./tsconfig.json"
+    ]
+  },
+  "ignorePatterns": ["*.js"],
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/strict",
+    "plugin:@typescript-eslint/stylistic"
+  ],
+  "rules": {
+    "@typescript-eslint/consistent-type-definitions": ["error", "interface"],
+
+    "class-methods-use-this": "off",
+    "@typescript-eslint/class-methods-use-this": "error",
+
+    "dot-notation": "off",
+    "@typescript-eslint/dot-notation": "error",
+
+    "no-array-constructor": "off",
+    "@typescript-eslint/no-array-constructor": "error",
+
+    "no-empty-function": "off",
+    "@typescript-eslint/no-empty-function": "error",
+
+    "@typescript-eslint/no-extraneous-class": ["error", {"allowStaticOnly": true}],
+
+    "no-extra-semi": "off",
+    "@typescript-eslint/no-extra-semi": "error",
+
+    "no-loop-func": "off",
+    "@typescript-eslint/no-loop-func": "error",
+
+    "no-loss-of-precision": "off",
+    "@typescript-eslint/no-loss-of-precision": "error",
+
+    "no-magic-numbers": "off",
+    "@typescript-eslint/no-magic-numbers": "off",
+
+    "no-shadow": "off",
+    "@typescript-eslint/no-shadow": "error",
+
+    "no-unused-expressions": "off",
+    "@typescript-eslint/no-unused-expressions": "error",
+
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": "error",
+
+    "no-use-before-define": "off",
+    "@typescript-eslint/no-use-before-define": "error",
+
+    "no-useless-constructor": "off",
+    "@typescript-eslint/no-useless-constructor": "error",
+
+    "@typescript-eslint/class-literal-property-style": ["error", "getters"]
+  }
+}

.github/ISSUE_TEMPLATE/bug-report.yaml

@@ -0,0 +1,37 @@
+name: Bug Report
+description: Use this form to submit a bug report.
+title: "Bug Report - [DATE]: [BUG SUMMARY]"
+labels: [ "bug" ]
+body:
+  - type: input
+    id: browserName
+    attributes:
+      label: Browser Name
+      description: What browser are you using?
+      placeholder: "Example: Firefox"
+    validations:
+      required: true
+  - type: input
+    id: browserVersion
+    attributes:
+      label: Browser Version
+      description: What version of your browser are you using?
+      placeholder: "Example: v121.0"
+    validations:
+      required: false
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      description: The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it.
+      options:
+        - label: "I agree to follow this project's [Code of Conduct](https://github.com/brittni-and-the-polar-bear/.github/tree/main?tab=coc-ov-file#readme)."
+          required: true
+  - type: textarea
+    attributes:
+      label: Issue Description
+      description: Please explain in detail the problems you are experiencing with the program.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: "## Thank you for your feedback!"

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Code of Conduct Violations
+    url: https://tr.ee/O4CuCemckO
+    about: Please report any Code of Conduct violations here.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,18 @@
+---
+name: Feature Request
+about: Use this form to request a feature.
+title: "Feature Request - [DATE]: [Feature Summary]"
+labels: enhancement
+---
+
+# Description
+
+Place the description of your new feature here.
+
+# Tasks
+
+If you are familiar with the development requirements, place the tasks you expect will need to be completed for this
+feature here.
+
+- [ ] task 1
+- [ ] task 2

.github/dependabot.yml

@@ -0,0 +1,46 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    target-branch: "development-main"
+    allow:
+      - dependency-type: "all"
+    versioning-strategy: increase
+    commit-message:
+      prefix: "dependabot npm update"
+      include: "scope"
+    groups:
+      development-dependencies:
+        dependency-type: "development"
+        update-types:
+        - "major"
+        - "minor"
+        - "patch"
+      production-dependencies:
+        dependency-type: "production"
+        update-types:
+        - "major"
+        - "minor"
+        - "patch"
+    reviewers:
+      - "blwatkins"
+      - "azurepolarbear"
+
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+    target-branch: "development-main"
+    commit-message:
+      prefix: "dependabot github-action update"
+      include: "scope"
+    reviewers:
+      - "blwatkins"
+      - "azurepolarbear"

.github/workflows/codeql.yml

@@ -0,0 +1,81 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main", "development-main" ]
+  pull_request:
+    branches: [ "main", "development-main" ]
+  schedule:
+    - cron: '0 12 * * *'
+
+jobs:
+  analyze:
+    name: Analyze
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners
+    # Consider using larger runners for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript-typescript' ]
+        # CodeQL supports [ 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' ]
+        # Use only 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js Build and Test
+
+on:
+  push:
+    branches: [ "main", "development-main" ]
+  pull_request:
+    branches: [ "main", "development-main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build:source --if-present
+      - run: npm test

.github/workflows/npm-publish.yml

@@ -0,0 +1,34 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package Publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+      - run: npm ci
+      - run: npm run build:source --if-present
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.gitignore

@@ -0,0 +1,18 @@
+*.DS_Store
+
+# WebStorm
+.idea/
+
+# npm
+node_modules/
+
+# output
+out/
+dist/
+types/
+
+# api extractor
+api/temp/
+
+# jest
+src/**/*.js

.node-version

@@ -0,0 +1 @@
+v20.11.0

README.md

@@ -1,2 +1,9 @@
-# generative-art-library_base
-Base classes and methods for the brittni and the polar bear generative art library.
+# Generative Art Library: Base
+
+Copyright (C) 2023-2024 Brittni Watkins
+
+Base classes and methods for the brittni and the polar bear [generative art library](https://github.com/brittni-and-the-polar-bear/generative-art-library).
+
+## LICENSE Information
+
+The source code of this project is licensed under the [GNU Affero General Public Version 3.0 License](https://www.gnu.org/licenses/agpl-3.0.en.html). The full text of the license can be found in the LICENSE file of the root directory.