Skip to content
This repository has been archived by the owner on Jan 24, 2024. It is now read-only.

Commit

Permalink
refactor: reorganize meta config
Browse files Browse the repository at this point in the history
  • Loading branch information
thetutlage committed Jan 17, 2022
1 parent 651cd51 commit 3f8e805
Show file tree
Hide file tree
Showing 16 changed files with 69 additions and 77 deletions.
4 changes: 2 additions & 2 deletions japaFile.js → .bin/test.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
process.env.DEBUG = 'adonis:require-ts'
require('ts-node/register')
require('@adonisjs/require-ts/build/register')

const { configure } = require('japa')

configure({
files: ['test/**/*.spec.ts'],
})
1 change: 0 additions & 1 deletion .eslintignore

This file was deleted.

17 changes: 0 additions & 17 deletions .eslintrc.json

This file was deleted.

10 changes: 3 additions & 7 deletions .github/COMMIT_CONVENTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@
Using conventional commit messages, we can automate the process of generating the CHANGELOG file. All commits messages will automatically be validated against the following regex.

```js
;/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|ci|chore|types|build|improvement)((.+))?: .{1,50}/
``` js
/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|ci|chore|types|build|improvement)((.+))?: .{1,50}/
```

## Commit Message Format
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:

> The **scope** is optional
Expand All @@ -27,7 +26,6 @@ Prefix makes it easier to append a path to a group of routes
5. The optional **footer** can be added after the body, followed by a blank line.

## Types

Only one type can be used at a time and only following types are allowed.

- feat
Expand All @@ -46,15 +44,12 @@ Only one type can be used at a time and only following types are allowed.
If a type is `feat`, `fix` or `perf`, then the commit will appear in the CHANGELOG.md file. However if there is any BREAKING CHANGE, the commit will always appear in the changelog.

### Revert

If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>`., where the hash is the SHA of the commit being reverted.

## Scope

The scope could be anything specifying place of the commit change. For example: `router`, `view`, `querybuilder`, `database`, `model` and so on.

## Subject

The subject contains succinct description of the change:

- use the imperative, present tense: "change" not "changed" nor "changes".
Expand All @@ -72,3 +67,4 @@ The footer should contain any information about **Breaking Changes** and is also
reference GitHub issues that this commit **Closes**.

**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

12 changes: 5 additions & 7 deletions CONTRIBUTING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

AdonisJs is a community driven project. You are free to contribute in any of the following ways.
AdonisJS is a community driven project. You are free to contribute in any of the following ways.

- [Coding style](coding-style)
- [Fix bugs by creating PR's](fix-bugs-by-creating-prs)
Expand All @@ -10,7 +10,7 @@ AdonisJs is a community driven project. You are free to contribute in any of the

## Coding style

Majority of AdonisJs core packages are written in Typescript. Having a brief knowledge of Typescript is required to contribute to the core. [Learn more](https://adonisjs.com/coding-style) about the same.
Majority of AdonisJS core packages are written in Typescript. Having a brief knowledge of Typescript is required to contribute to the core.

## Fix bugs by creating PR's

Expand All @@ -35,14 +35,12 @@ RFC stands for **Request for Commits**, a standard process followed by many othe

In brief, RFC process allows you to talk about the changes with everyone in the community and get a view of the core team before dedicating your time to work on the feature.

The RFC proposals are created as issues on [adonisjs/rfcs](https://github.com/adonisjs/rfcs) repo. Make sure to read the README to learn about the process in depth.
The RFC proposals are created as Pull Request on [adonisjs/rfcs](https://github.com/adonisjs/rfcs) repo. Make sure to read the README to learn about the process in depth.

## Report security issues

All of the security issues, must be reported via [email](mailto:[email protected]) and not using any of the public channels. [Learn more](https://adonisjs.com/security) about the security policy
All of the security issues, must be reported via [email](mailto:[email protected]) and not using any of the public channels.

## Be a part of community

We welcome you to participate in the [forum](https://forum.adonisjs.com/) and the AdonisJs [discord server](https://discord.me/adonisjs). You are free to ask your questions and share your work or contributions made to AdonisJs eco-system.

We follow a strict [Code of Conduct](https://adonisjs.com/community-guidelines) to make sure everyone is respectful to each other.
We welcome you to participate in [GitHub Discussion](https://github.com/adonisjs/core/discussions) and the AdonisJS [Discord Server](https://discord.gg/vDcEjq6). You are free to ask your questions and share your work or contributions made to AdonisJS eco-system.
8 changes: 2 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,20 @@ about: Report identified bugs
We do our best to reply to all the issues on time. If you will follow the given guidelines, the turn around time will be faster.

- Lots of raised issues are directly not bugs but instead are design decisions taken by us.
- Make use of our [forum](https://forum.adonisjs.com/), or [discord server](https://discord.me/adonisjs), if you are not sure that you are reporting a bug.
- Make use of our [GH discussions](https://github.com/adonisjs/core/discussions), or [discord server](https://discord.me/adonisjs), if you are not sure that you are reporting a bug.
- Ensure the issue isn't already reported.
- Ensure you are reporting the bug in the correct repo.

_Delete the above section and the instructions in the sections below before submitting_
*Delete the above section and the instructions in the sections below before submitting*

## Package version

<!-- YOUR ANSWER -->

## Node.js and npm version

<!-- YOUR ANSWER -->

## Sample Code (to reproduce the issue)

<!-- YOUR ANSWER -->

## BONUS (a sample repo to reproduce the issue)

<!-- YOUR ANSWER -->
5 changes: 1 addition & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,13 @@ Please create an [RFC](https://github.com/adonisjs/rfcs) instead, if
- Feature introduces a breaking change
- Demands lots of time and changes in the current code base.

_Delete the above section and the instructions in the sections below before submitting_
*Delete the above section and the instructions in the sections below before submitting*

## Why this feature is required (specific use-cases will be appreciated)?

<!-- YOUR ANSWER -->

## Have you tried any other work arounds?

<!-- YOUR ANSWER -->

## Are you willing to work on it with little guidance?

<!-- YOUR ANSWER -->
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ _Put an `x` in the boxes that apply_

_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._

- [ ] I have read the [CONTRIBUTING](https://github.com/adonisjs/require-ts/blob/master/CONTRIBUTING.md) doc
- [ ] I have read the [CONTRIBUTING](https://github.com/adonisjs/require-ts/blob/master/.github/CONTRIBUTING.md) doc
- [ ] Lint and unit tests pass locally with my changes
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] I have added necessary documentation (if appropriate)
Expand Down
4 changes: 2 additions & 2 deletions .github/stale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ daysUntilClose: 7

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

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

# Comment to post when marking an issue as stale. Set to `false` to disable
markComment: >
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
matrix:
node-version:
- 14.15.4
- 16.x
- 17.x
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
Expand All @@ -26,7 +26,7 @@ jobs:
matrix:
node-version:
- 14.15.4
- 16.x
- 17.x
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
Expand Down
1 change: 0 additions & 1 deletion .npmrc

This file was deleted.

1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ config.json
package.json
*.html
*.txt
*.md
10 changes: 0 additions & 10 deletions .prettierrc

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The MIT License

Copyright 2021 Harminder Virk, contributors
Copyright 2022 Harminder Virk, contributors

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:

Expand Down
13 changes: 0 additions & 13 deletions config.json

This file was deleted.

52 changes: 49 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
"scripts": {
"mrm": "mrm --preset=@adonisjs/mrm-preset",
"pretest": "npm run lint",
"test": "cross-env FORCE_COLOR=true node japaFile.js",
"test": "node .bin/test.js",
"clean": "del build",
"compile": "npm run lint && npm run clean && tsc",
"build": "npm run compile",
"prepublishOnly": "npm run build",
"lint": "eslint . --ext=.ts",
"format": "prettier --write .",
"commit": "git-cz",
"release": "np",
"release": "np --message=\"chore(release): %s\"",
"version": "npm run build",
"sync-labels": "github-label-sync --labels ./node_modules/@adonisjs/mrm-preset/gh-labels.json adonisjs/require-ts"
},
Expand All @@ -27,11 +27,14 @@
"license": "MIT",
"devDependencies": {
"@adonisjs/mrm-preset": "^5.0.2",
"@adonisjs/require-ts": "^2.0.8",
"@poppinss/dev-utils": "^2.0.1",
"@types/node": "^17.0.8",
"@types/source-map-support": "^0.5.4",
"benchmark": "^2.1.4",
"commitizen": "^4.2.4",
"cross-env": "^7.0.3",
"cz-conventional-changelog": "^3.3.0",
"del-cli": "^4.0.1",
"eslint": "^8.7.0",
"eslint-config-prettier": "^8.3.0",
Expand Down Expand Up @@ -92,5 +95,48 @@
"bugs": {
"url": "https://github.com/adonisjs/require-ts/issues"
},
"homepage": "https://github.com/adonisjs/require-ts#readme"
"homepage": "https://github.com/adonisjs/require-ts#readme",
"mrmConfig": {
"core": true,
"license": "MIT",
"services": [
"github-actions"
],
"minNodeVersion": "14.15.4",
"probotApps": [
"stale",
"lock"
],
"runGhActionsOnWindows": true
},
"eslintConfig": {
"extends": [
"plugin:adonis/typescriptPackage",
"prettier"
],
"plugins": [
"prettier"
],
"rules": {
"prettier/prettier": [
"error",
{
"endOfLine": "auto"
}
]
}
},
"eslintIgnore": [
"build"
],
"prettier": {
"trailingComma": "es5",
"semi": false,
"singleQuote": true,
"useTabs": false,
"quoteProps": "consistent",
"bracketSpacing": true,
"arrowParens": "always",
"printWidth": 100
}
}

0 comments on commit 3f8e805

Please sign in to comment.