Skip to content

Commit 283cac2

Browse files
committed
refactor: reorganize meta config
1 parent 0d02df2 commit 283cac2

14 files changed

+70
-65
lines changed

japaFile.js .bin/test.js

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
require('@adonisjs/require-ts/build/register')
22

33
const { configure } = require('japa')
4+
45
configure({
56
files: ['test/**/*.spec.ts'],
67
})

.eslintignore

-1
This file was deleted.

.eslintrc.json

-17
This file was deleted.
+11-13
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Contributing
22

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

5-
- [Coding style](#coding-style)
6-
- [Fix bugs by creating PR's](#fix-bugs-by-creating-prs)
7-
- [Share an RFC for new features or big changes](#share-an-rfc-for-new-features-or-big-changes)
8-
- [Report security issues](#report-security-issues)
9-
- [Be a part of the community](#be-a-part-of-community)
5+
- [Coding style](coding-style)
6+
- [Fix bugs by creating PR's](fix-bugs-by-creating-prs)
7+
- [Share an RFC for new features or big changes](share-an-rfc-for-new-features-or-big-changes)
8+
- [Report security issues](report-security-issues)
9+
- [Be a part of the community](be-a-part-of-community)
1010

1111
## Coding style
1212

13-
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/docs/contribution-guide#_coding_style) about the same.
13+
Majority of AdonisJS core packages are written in Typescript. Having a brief knowledge of Typescript is required to contribute to the core.
1414

1515
## Fix bugs by creating PR's
1616

@@ -31,18 +31,16 @@ Sharing PR's for small changes works great. However, when contributing big featu
3131

3232
### What is an RFC?
3333

34-
RFC stands for **Request for Commits**, a standard process followed by many other frameworks including [Ember](https://github.com/emberjs/rfcs), [yarn](https://github.com/yarnpkg/rfcs) and [rust](https://github.com/rust-lang/rfcs).
34+
RFC stands for **Request for Commits**, a standard process followed by many other frameworks including [Ember](https://github.com/emberjs/rfcs), [yarn](https://github.com/yarnpkg/rfcs) and [rust](https://github.com/rust-lang/rfcs).
3535

3636
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.
3737

38-
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.
38+
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.
3939

4040
## Report security issues
4141

42-
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/docs/security-introduction) about the security policy
42+
All of the security issues, must be reported via [email](mailto:[email protected]) and not using any of the public channels.
4343

4444
## Be a part of community
4545

46-
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.
47-
48-
We follow a strict [Code of Conduct](https://preview.adonisjs.com/code-of-conduct) to make sure everyone is respectful to each other.
46+
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.

.github/ISSUE_TEMPLATE/bug_report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ about: Report identified bugs
1010
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.
1111

1212
- Lots of raised issues are directly not bugs but instead are design decisions taken by us.
13-
- 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.
13+
- 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.
1414
- Ensure the issue isn't already reported.
1515
- Ensure you are reporting the bug in the correct repo.
1616

.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ _Put an `x` in the boxes that apply_
1818

1919
_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._
2020

21-
- [ ] I have read the [CONTRIBUTING](https://github.com/adonisjs/core/blob/master/CONTRIBUTING.md) doc
21+
- [ ] I have read the [CONTRIBUTING](https://github.com/adonisjs/core/blob/master/.github/CONTRIBUTING.md) doc
2222
- [ ] Lint and unit tests pass locally with my changes
2323
- [ ] I have added tests that prove my fix is effective or that my feature works.
2424
- [ ] I have added necessary documentation (if appropriate)

.github/stale.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ daysUntilClose: 7
66

77
# Issues with these labels will never be considered stale
88
exemptLabels:
9-
- 'Type: Security'
9+
- "Type: Security"
1010

1111
# Label to use when marking an issue as stale
12-
staleLabel: 'Status: Abandoned'
12+
staleLabel: "Status: Abandoned"
1313

1414
# Comment to post when marking an issue as stale. Set to `false` to disable
1515
markComment: >

.github/workflows/test.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
matrix:
1010
node-version:
1111
- 14.15.4
12-
- 16.x
12+
- 17.x
1313
steps:
1414
- uses: actions/checkout@v2
1515
- name: Use Node.js ${{ matrix.node-version }}
@@ -26,7 +26,7 @@ jobs:
2626
matrix:
2727
node-version:
2828
- 14.15.4
29-
- 16.x
29+
- 17.x
3030
steps:
3131
- uses: actions/checkout@v2
3232
- name: Use Node.js ${{ matrix.node-version }}

.npmrc

-1
This file was deleted.

.prettierrc

-10
This file was deleted.

LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The MIT License
22

3-
Copyright 2021 Harminder Virk, contributors
3+
Copyright 2022 Harminder Virk, contributors
44

55
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:
66

config.json

-13
This file was deleted.

package.json

+48-2
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@
3434
"scripts": {
3535
"mrm": "mrm --preset=@adonisjs/mrm-preset",
3636
"pretest": "npm run lint",
37-
"test": "node japaFile.js",
37+
"test": "node .bin/test.js",
3838
"clean": "del build",
3939
"compile": "npm run lint && npm run clean && tsc && copyfiles templates/**/* templates/* build",
4040
"build": "npm run compile",
4141
"commit": "git-cz",
42-
"release": "np",
42+
"release": "np --message=\"chore(release): %s\"",
4343
"version": "npm run build",
4444
"prepublishOnly": "npm run build",
4545
"lint": "eslint . --ext=.ts",
@@ -72,7 +72,9 @@
7272
"@types/node": "^17.0.9",
7373
"@types/supertest": "^2.0.11",
7474
"clear-module": "^4.1.2",
75+
"commitizen": "^4.2.4",
7576
"copyfiles": "^2.4.1",
77+
"cz-conventional-changelog": "^3.3.0",
7678
"del-cli": "^4.0.1",
7779
"eslint": "^8.7.0",
7880
"eslint-config-prettier": "^8.3.0",
@@ -185,5 +187,49 @@
185187
"publishConfig": {
186188
"access": "public",
187189
"tag": "latest"
190+
},
191+
"mrmConfig": {
192+
"core": true,
193+
"license": "MIT",
194+
"services": [
195+
"github-actions"
196+
],
197+
"minNodeVersion": "14.15.4",
198+
"probotApps": [
199+
"stale",
200+
"lock"
201+
],
202+
"runGhActionsOnWindows": true
203+
},
204+
"main": "build/index.js",
205+
"eslintConfig": {
206+
"extends": [
207+
"plugin:adonis/typescriptPackage",
208+
"prettier"
209+
],
210+
"plugins": [
211+
"prettier"
212+
],
213+
"rules": {
214+
"prettier/prettier": [
215+
"error",
216+
{
217+
"endOfLine": "auto"
218+
}
219+
]
220+
}
221+
},
222+
"eslintIgnore": [
223+
"build"
224+
],
225+
"prettier": {
226+
"trailingComma": "es5",
227+
"semi": false,
228+
"singleQuote": true,
229+
"useTabs": false,
230+
"quoteProps": "consistent",
231+
"bracketSpacing": true,
232+
"arrowParens": "always",
233+
"printWidth": 100
188234
}
189235
}

tsconfig.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,7 @@
55
"experimentalDecorators": true,
66
"emitDecoratorMetadata": true
77
},
8-
"files": ["./node_modules/@adonisjs/repl/build/adonis-typings/index.d.ts"]
8+
"files": [
9+
"./node_modules/@adonisjs/repl/build/adonis-typings/index.d.ts"
10+
]
911
}

0 commit comments

Comments
 (0)