Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
rsaz authored Apr 27, 2024
0 parents commit b7b298c
Show file tree
Hide file tree
Showing 28 changed files with 1,132 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/* eslint-env node */
module.exports = {
extends: [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"eslint-config-prettier",
"prettier",
],
parser: "@typescript-eslint/parser",
parserOptions: {
project: ["./tsconfig.cjs.json", "./tsconfig.esm.json","./tsconfig.json"],
},
plugins: ["@typescript-eslint"],
root: true,
env: {
node: true,
jest: true,
},
ignorePatterns: [
"lib",
"node_modules",
".eslintrc.cjs",
"**/__tests__/*.spec.ts",
"vitest.config.ts",
],
rules: {
"@typescript-eslint/adjacent-overload-signatures": "error",
"@typescript-eslint/array-type": ["error", { default: "generic" }],
"@typescript-eslint/await-thenable": "error",
"@typescript-eslint/ban-types": "error",
"@typescript-eslint/class-literal-property-style": "error",
"@typescript-eslint/explicit-function-return-type": "error",
},
};

1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.ts linguist-language=TypeScript
91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
name: "\U0001F41B Bug Report"
description: "If something isn't working as expected \U0001F914"
labels: ["needs triage"]
body:
- type: markdown
attributes:
value: |
## :warning: We use GitHub Issues to track bug reports and feature requests
If you are not sure that your issue is a bug, you could:

- use our [Discord community](https://discord.gg/A877Mc3V)
- use [StackOverflow using the tag `expressots`](https://stackoverflow.com/questions/tagged/expressots)

**NOTE:** You don't need to answer questions that you know that aren't relevant.

---

- type: checkboxes
attributes:
label: "Is there an existing issue for this?"
description: "Please search [here](../issues?q=is%3Aissue) to see if an issue already exists for the bug you encountered"
options:
- label: "I have searched the existing issues"
required: true

- type: textarea
validations:
required: true
attributes:
label: "Current behavior"
description: "How the issue manifests?"

- type: textarea
attributes:
label: "Steps to reproduce"
description: |
How the issue manifests?
You could leave this blank if you can't reproduce it, but please provide as much information as possible
placeholder: |
1. `npm ci`
2. `npm start:dev`
3. See error...
- type: textarea
validations:
required: true
attributes:
label: "Expected behavior"
description: "A clear and concise description of what you expected to happened (or code)"

- type: markdown
attributes:
value: |
---
- type: input
validations:
required: true
attributes:
label: "Package version"
description: |
Which version of `@expressots/core` are you using?
**Tip**: Make sure that all of yours `@expressots/*` dependencies are in sync!
placeholder: "1.2.0"

- type: input
attributes:
label: "Node.js version"
description: "Which version of Node.js are you using?"
placeholder: "18.0.10"

- type: checkboxes
attributes:
label: "In which operating systems have you tested?"
options:
- label: macOS
- label: Windows
- label: Linux

- type: markdown
attributes:
value: |
---
- type: textarea
attributes:
label: "Other"
description: |
Anything else relevant? eg: Logs, OS version, IDE, package manager, etc.
**Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in
73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/community_ideas.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: "\U0001F680 Community Ideas"
description: "I have an idea or proposal \U0001F4A1!"
labels: ["needs triage"]
assignees:
- "rsaz"
body:
- type: markdown
attributes:
value: |
## :heart: We would love to hear your ideas and proposals
Suggest an idea for a specific feature, product, process, anything you wish to propose to the community for comment and discussion.

**NOTE:** If your idea is approved after discussion, you will be asked to create a new issue with the appropriate template.

---

- type: checkboxes
attributes:
label: "Is there an existing proposal similar to this?"
description: "Please make sure that your idea is not already proposed otherwise you will be asked to comment on the existing proposal"
options:
- label: "I have searched the existing proposals"
required: true

- type: textarea
validations:
required: true
attributes:
label: "What are you proposing?"
description: "In a few sentences, describe your idea or proposal"
placeholder: |
My idea is ...
- type: textarea
validations:
required: true
attributes:
label: "Is there any specific group of users that will benefit from this?"
description: "Highlight any research, proposals, requests or anecdotes that signal this is the right thing to build. Include links to GitHub Issues, Forums, Stack Overflow, Twitter, Etc"
placeholder: |
I have seen ...
- type: textarea
validations:
required: true
attributes:
label: "What problems are you trying to solve?"
description: "Describe the problems that this idea or proposal will solve"
placeholder: |
I am trying to solve ...
- type: textarea
validations:
required: true
attributes:
label: "Do you have any references or examples that can illustrate your idea?"
description: "If you have any references or examples that can illustrate your idea, who is using it, and how it is being used, please share them here"
placeholder: |
I have seen ...
- type: dropdown
id: idea-type
validations:
required: true
attributes:
label: "What type of idea is this?"
description: "Select the type of idea that this is"
multiple: false
options:
- "Innovation: No similar idea exists"
- "Improvement of existing idea: Similar idea exists but this is an improvement"
- "Copy of existing idea: Similar idea exists and this is a copy"
47 changes: 47 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Pull Request Guidelines

Our guidelines for submitting a pull request.

## Before submitting a Pull Request, please make sure you have verified the following:

- [ ] The commit message follows our guidelines:
- A good commit message should be two things: meaningful and concise. It should not contain every single detail, describing each changed line—we can see all the changes in Git—but, at the same time, it should say enough to avoid ambiguity.
- We use Microverse's commit message convention
- The convention stablish that a commit message has to be in the present tense, imperative and lowercase.
- Example: `fix typo in README.md`
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)

## PR Type

What kind of change does this PR introduce?

<!-- Please check the one that applies to this PR using "x". -->
- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Other... Please describe:

## What is the current behavior?

Please describe the current behavior that you are modifying, or link to a relevant issue.

Issue Number: N/A

## What is the new behavior?

Describe the new behavior or link to a relevant issue.

## Does this PR introduce a breaking change?

- [ ] Yes
- [ ] No

If this PR contains a breaking change, please describe the impact and migration path for existing applications below.

## Other information

Any other information that is important to this PR.
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# .github/dependabot.yml
version: 2
updates:
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: 'daily'
commit-message:
prefix: feat
prefix-development: feat
open-pull-requests-limit: 99
51 changes: 51 additions & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# name: Build and Test

# on:
# push:
# branches:
# - main
# pull_request:
# branches: ["main"]
# pull_request_target:
# types: [opened, synchronize, reopened]

# jobs:
# build:
# runs-on: ubuntu-latest

# steps:
# - name: Checkout code
# uses: actions/checkout@v2

# - name: Use Node.js
# uses: actions/setup-node@v2
# with:
# node-version: "18.11.0"

# - name: Install Dependencies
# run: npm install

# - name: Build
# run: npm run build

# - name: Unit Tests
# working-directory: ./src
# run: npm run test
# env:
# CI: true

# - name: Run Code Coverage
# working-directory: ./src
# run: npm run coverage

# - name: Upload coverage reports to Codecov
# uses: codecov/[email protected]
# with:
# working-directory: .
# token: ${{ secrets.CODECOV_TOKEN }}

# - name: Set up .npmrc
# run: echo "//npm.pkg.github.com/:_authToken=${{ secrets.NPM_TOKEN }}" >> .npmrc

# - name: Install dependencies
# run: npm ci
47 changes: 47 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: "CodeQL Analysis Report"

on:
push:
branches: [ "main" ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "main" ]
schedule:
- cron: '0 17 * * 4'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write

strategy:
fail-fast: false
matrix:
language: [ 'typescript' ]
node-version: [ '18.10.0' ]

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Setup Node.js
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
continue-on-error: true
with:
languages: ${{ matrix.language }}

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
with:
category: "/language:${{matrix.language}}"
path: "packages/core"
23 changes: 23 additions & 0 deletions .github/workflows/codesee-arch-diagram.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# This workflow was added by CodeSee. Learn more at https://codesee.io/
# This is v2.0 of this workflow file
on:
push:
branches:
- main
pull_request_target:
types: [opened, synchronize, reopened]

name: CodeSee

permissions: read-all

jobs:
codesee:
runs-on: ubuntu-latest
continue-on-error: true
name: Analyze the repo with CodeSee
steps:
- uses: Codesee-io/codesee-action@v2
with:
codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
codesee-url: https://app.codesee.io
Loading

0 comments on commit b7b298c

Please sign in to comment.