Skip to content

Commit 0f1650b

Browse files
chore: projen configurations (#1)
* chore(projen): repository basic configuration * chore(projen): add conventional commit scripts we installed commitzent as script to write conventional commits * chore(projen): update package json script to execute commitzent
1 parent a736575 commit 0f1650b

File tree

16 files changed

+1144
-181
lines changed

16 files changed

+1144
-181
lines changed

.cz-config.js

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
module.exports = {
2+
types: [
3+
{ value: 'feat', name: 'feat: A new feature' },
4+
{ value: 'fix', name: 'fix: A bug fix' },
5+
{ value: 'docs', name: 'docs: Documentation only changes' },
6+
{
7+
value: 'style',
8+
name: 'style: Changes that do not affect the meaning of the code\n (white-space, formatting, missing semi-colons, etc)',
9+
},
10+
{
11+
value: 'refactor',
12+
name: 'refactor: A code change that neither fixes a bug nor adds a feature',
13+
},
14+
{
15+
value: 'perf',
16+
name: 'perf: A code change that improves performance',
17+
},
18+
{ value: 'test', name: 'test: Adding missing tests' },
19+
{
20+
value: 'chore',
21+
name: 'chore: Changes to the build process or auxiliary tools\n and libraries such as documentation generation',
22+
},
23+
{ value: 'revert', name: 'revert: Revert to a commit' },
24+
{ value: 'WIP', name: 'WIP: Work in progress' },
25+
],
26+
27+
scopes: [{ name: 'codestarconnection' }, { name: 'projen' }],
28+
29+
usePreparedCommit: true, // to re-use commit from ./.git/COMMIT_EDITMSG
30+
allowTicketNumber: false,
31+
isTicketNumberRequired: false,
32+
ticketNumberPrefix: 'TICKET-',
33+
ticketNumberRegExp: '\\d{1,5}',
34+
35+
// it needs to match the value for field type. Eg.: 'fix'
36+
/*
37+
scopeOverrides: {
38+
fix: [
39+
40+
{name: 'merge'},
41+
{name: 'style'},
42+
{name: 'e2eTest'},
43+
{name: 'unitTest'}
44+
]
45+
},
46+
*/
47+
// override the messages, defaults are as follows
48+
messages: {
49+
type: "Select the type of change that you're committing:",
50+
scope: '\nDenote the SCOPE of this change (optional):',
51+
// used if allowCustomScopes is true
52+
customScope: 'Denote the SCOPE of this change:',
53+
subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
54+
body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
55+
breaking: 'List any BREAKING CHANGES (optional):\n',
56+
footer:
57+
'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n',
58+
confirmCommit: 'Are you sure you want to proceed with the commit above?',
59+
},
60+
61+
allowCustomScopes: true,
62+
allowBreakingChanges: ['feat', 'fix'],
63+
// skip any questions you want
64+
// skipQuestions: ['scope', 'body'],
65+
66+
// limit subject length
67+
subjectLimit: 100,
68+
// breaklineChar: '|', // It is supported for fields body and footer.
69+
// footerPrefix : 'ISSUES CLOSED:'
70+
// askForBreakingChangeFirst : true, // default is false
71+
};

.czrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"path": "node_modules/cz-customizable"
3+
}

.eslintrc.json

Lines changed: 6 additions & 96 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.gitattributes

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.gitignore

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.prettierignore

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.prettierrc.json

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.projen/deps.json

Lines changed: 22 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.projen/files.json

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.projen/tasks.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)