Skip to content

Commit

Permalink
feat: initialize project
Browse files Browse the repository at this point in the history
  • Loading branch information
thetutlage committed Dec 18, 2023
1 parent c979b84 commit c6ff7a5
Show file tree
Hide file tree
Showing 11 changed files with 332 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# http://editorconfig.org

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.json]
insert_final_newline = ignore

[**.min.js]
indent_style = ignore
insert_final_newline = ignore

[MakeFile]
indent_style = space

[*.md]
trim_trailing_whitespace = false
170 changes: 170 additions & 0 deletions .github/labels.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
[
{
"name": "Priority: Critical",
"color": "ea0056",
"description": "The issue needs urgent attention",
"aliases": []
},
{
"name": "Priority: High",
"color": "5666ed",
"description": "Look into this issue before picking up any new work",
"aliases": []
},
{
"name": "Priority: Medium",
"color": "f4ff61",
"description": "Try to fix the issue for the next patch/minor release",
"aliases": []
},
{
"name": "Priority: Low",
"color": "87dfd6",
"description": "Something worth considering, but not a top priority for the team",
"aliases": []
},
{
"name": "Semver: Alpha",
"color": "008480",
"description": "Will make it's way to the next alpha version of the package",
"aliases": []
},
{
"name": "Semver: Major",
"color": "ea0056",
"description": "Has breaking changes",
"aliases": []
},
{
"name": "Semver: Minor",
"color": "fbe555",
"description": "Mainly new features and improvements",
"aliases": []
},
{
"name": "Semver: Next",
"color": "5666ed",
"description": "Will make it's way to the bleeding edge version of the package",
"aliases": []
},
{
"name": "Semver: Patch",
"color": "87dfd6",
"description": "A bug fix",
"aliases": []
},
{
"name": "Status: Abandoned",
"color": "ffffff",
"description": "Dropped and not into consideration",
"aliases": ["wontfix"]
},
{
"name": "Status: Accepted",
"color": "e5fbf2",
"description": "The proposal or the feature has been accepted for the future versions",
"aliases": []
},
{
"name": "Status: Blocked",
"color": "ea0056",
"description": "The work on the issue or the PR is blocked. Check comments for reasoning",
"aliases": []
},
{
"name": "Status: Completed",
"color": "008672",
"description": "The work has been completed, but not released yet",
"aliases": []
},
{
"name": "Status: In Progress",
"color": "73dbc4",
"description": "Still banging the keyboard",
"aliases": ["in progress"]
},
{
"name": "Status: On Hold",
"color": "f4ff61",
"description": "The work was started earlier, but is on hold now. Check comments for reasoning",
"aliases": ["On Hold"]
},
{
"name": "Status: Review Needed",
"color": "fbe555",
"description": "Review from the core team is required before moving forward",
"aliases": []
},
{
"name": "Status: Awaiting More Information",
"color": "89f8ce",
"description": "Waiting on the issue reporter or PR author to provide more information",
"aliases": []
},
{
"name": "Status: Need Contributors",
"color": "7057ff",
"description": "Looking for contributors to help us move forward with this issue or PR",
"aliases": []
},
{
"name": "Type: Bug",
"color": "ea0056",
"description": "The issue has indentified a bug",
"aliases": ["bug"]
},
{
"name": "Type: Security",
"color": "ea0056",
"description": "Spotted security vulnerability and is a top priority for the core team",
"aliases": []
},
{
"name": "Type: Duplicate",
"color": "00837e",
"description": "Already answered or fixed previously",
"aliases": ["duplicate"]
},
{
"name": "Type: Enhancement",
"color": "89f8ce",
"description": "Improving an existing feature",
"aliases": ["enhancement"]
},
{
"name": "Type: Feature Request",
"color": "483add",
"description": "Request to add a new feature to the package",
"aliases": []
},
{
"name": "Type: Invalid",
"color": "dbdbdb",
"description": "Doesn't really belong here. Maybe use discussion threads?",
"aliases": ["invalid"]
},
{
"name": "Type: Question",
"color": "eceafc",
"description": "Needs clarification",
"aliases": ["help wanted", "question"]
},
{
"name": "Type: Documentation Change",
"color": "7057ff",
"description": "Documentation needs some improvements",
"aliases": ["documentation"]
},
{
"name": "Type: Dependencies Update",
"color": "00837e",
"description": "Bump dependencies",
"aliases": ["dependencies"]
},
{
"name": "Good First Issue",
"color": "008480",
"description": "Want to contribute? Just filter by this label",
"aliases": ["good first issue"]
}
]
23 changes: 23 additions & 0 deletions .github/lock.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Configuration for Lock Threads - https://github.com/dessant/lock-threads-app

# Number of days of inactivity before a closed issue or pull request is locked
daysUntilLock: 60

# Skip issues and pull requests created before a given timestamp. Timestamp must
# follow ISO 8601 (`YYYY-MM-DD`). Set to `false` to disable
skipCreatedBefore: false

# Issues and pull requests with these labels will be ignored. Set to `[]` to disable
exemptLabels: ['Type: Security']

# Label to add before locking, such as `outdated`. Set to `false` to disable
lockLabel: false

# Comment to post before locking. Set to `false` to disable
lockComment: >
This thread has been automatically locked since there has not been
any recent activity after it was closed. Please open a new issue for
related bugs.
# Assign `resolved` as the reason for locking. Set to `false` to disable
setLockReason: false
21 changes: 21 additions & 0 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Number of days of inactivity before an issue becomes stale
daysUntilStale: 60

# Number of days of inactivity before a stale issue is closed
daysUntilClose: 7

# Issues with these labels will never be considered stale
exemptLabels:
- "Type: Security"

# Label to use when marking an issue as stale
staleLabel: "Status: Abandoned"

# Comment to post when marking an issue as stale. Set to `false` to disable
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Comment to post when closing a stale issue. Set to `false` to disable
closeComment: false
14 changes: 14 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: checks
on:
- push
- pull_request

jobs:
test:
uses: adonisjs/.github/.github/workflows/test.yml@main

lint:
uses: adonisjs/.github/.github/workflows/lint.yml@main

typecheck:
uses: adonisjs/.github/.github/workflows/typecheck.yml@main
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
node_modules
coverage
.DS_STORE
.nyc_output
.idea
.vscode/
*.sublime-project
*.sublime-workspace
*.log
build
dist
package-lock.json
yarn.lock
shrinkwrap.yaml
test/__app/
test/__app
4 changes: 4 additions & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx --no -- commitlint --edit
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package-lock=false
9 changes: 9 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# The MIT License

Copyright (c) 2023 Harminder Virk

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.
45 changes: 45 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"name": "@adonisjs/presets",
"version": "0.0.0",
"description": "A collection of presets to configure AdonisJS packages",
"main": "index.js",
"scripts": {
"test": "c8 npm run vscode:test"
},
"keywords": [
"adonisjs",
"presets"
],
"author": "virk,adonisjs",
"license": "MIT",
"devDependencies": {
"@adonisjs/eslint-config": "^1.2.0",
"@adonisjs/prettier-config": "^1.2.0",
"@adonisjs/tsconfig": "^1.2.0",
"@commitlint/cli": "^18.4.3",
"@commitlint/config-conventional": "^18.4.3",
"@swc/core": "^1.3.100",
"c8": "^8.0.1",
"husky": "^8.0.3",
"ts-node": "^10.9.2",
"typescript": "^5.3.3"
},
"prettier": "@adonisjs/prettier-config",
"eslintConfig": {
"extends": "@adonisjs/eslint-config/package"
},
"c8": {
"reporter": [
"text",
"html"
],
"exclude": [
"tests/**"
]
},
"commitlint": {
"extends": [
"@commitlint/config-conventional"
]
}
}
7 changes: 7 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": "@adonisjs/tsconfig/tsconfig.package.json",
"compilerOptions": {
"rootDir": "./",
"outDir": "./build"
}
}

0 comments on commit c6ff7a5

Please sign in to comment.