Skip to content

Commit 9c00738

Browse files
ethan-mfbethan-mfb
authored
Merge pull request #3 from MFB-Technologies-Inc/init-source
Init source
2 parents a81cbe3 + 80fce40 commit 9c00738

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+8054
-2
lines changed

‎.eslintrc.json‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"env": {
3+
"browser": false,
4+
"commonjs": false,
5+
"es2021": true,
6+
"node": true
7+
},
8+
"extends": [
9+
"eslint:recommended",
10+
"plugin:@typescript-eslint/recommended",
11+
"prettier"
12+
],
13+
"parser": "@typescript-eslint/parser",
14+
"parserOptions": {
15+
"ecmaVersion": "latest",
16+
"project": ["./tsconfig.json"],
17+
"sourceType": "module"
18+
},
19+
"plugins": ["@typescript-eslint"],
20+
"rules": {
21+
"@typescript-eslint/no-explicit-any": 0,
22+
"@typescript-eslint/consistent-type-definitions": [1, "type"],
23+
"@typescript-eslint/naming-convention": [
24+
"error",
25+
{
26+
"selector": "parameter",
27+
"format": ["camelCase"],
28+
"leadingUnderscore": "allow"
29+
}
30+
],
31+
"@typescript-eslint/typedef": 0,
32+
"@typescript-eslint/no-floating-promises": "warn",
33+
"@typescript-eslint/no-unused-vars": "warn",
34+
"@typescript-eslint/method-signature-style": "error"
35+
},
36+
"ignorePatterns": [
37+
"src/**/*.test.ts",
38+
"out/**/*",
39+
"jest.config.cjs",
40+
"babel.config.cjs",
41+
"scripts/**/*",
42+
"rollup.config.js"
43+
]
44+
}

‎.github/workflows/build.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: pr-build-pipeline
2+
3+
on:
4+
# Trigger analysis when pushing in main or pull requests, and when creating a pull request.
5+
push:
6+
branches:
7+
- main
8+
pull_request:
9+
types: [opened, synchronize, reopened]
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
jobs:
15+
pr_build_pipeline:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Check out repository code
19+
uses: actions/checkout@v3
20+
with:
21+
# Disabling shallow clone is recommended for improving relevancy of reporting
22+
fetch-depth: 0
23+
24+
- name: Setup node
25+
uses: actions/setup-node@v3
26+
with:
27+
node-version: "16"
28+
29+
- name: Install packages
30+
run: npm install
31+
32+
- name: Check formatting
33+
run: npm run check-formatting
34+
35+
- name: Build project and dependencies
36+
run: npm run build
37+
38+
- name: Run unit tests and generate report
39+
run: npm run test:ci
40+
41+
- name: SonarCloud Scan
42+
uses: sonarsource/sonarcloud-github-action@master
43+
env:
44+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
45+
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,5 @@ dist
102102

103103
# TernJS port file
104104
.tern-port
105+
106+
out/

‎.prettierignore‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
9+
# Diagnostic reports (https://nodejs.org/api/report.html)
10+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11+
12+
# Runtime data
13+
pids
14+
*.pid
15+
*.seed
16+
*.pid.lock
17+
18+
# Directory for instrumented libs generated by jscoverage/JSCover
19+
lib-cov
20+
21+
# Coverage directory used by tools like istanbul
22+
coverage
23+
*.lcov
24+
25+
# nyc test coverage
26+
.nyc_output
27+
28+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29+
.grunt
30+
31+
# Bower dependency directory (https://bower.io/)
32+
bower_components
33+
34+
# node-waf configuration
35+
.lock-wscript
36+
37+
# Compiled binary addons (https://nodejs.org/api/addons.html)
38+
build/Release
39+
40+
# Dependency directories
41+
node_modules/
42+
jspm_packages/
43+
44+
# TypeScript v1 declaration files
45+
typings/
46+
47+
# TypeScript cache
48+
*.tsbuildinfo
49+
50+
# Optional npm cache directory
51+
.npm
52+
53+
# Optional eslint cache
54+
.eslintcache
55+
56+
# Microbundle cache
57+
.rpt2_cache/
58+
.rts2_cache_cjs/
59+
.rts2_cache_es/
60+
.rts2_cache_umd/
61+
62+
# Optional REPL history
63+
.node_repl_history
64+
65+
# Output of 'npm pack'
66+
*.tgz
67+
68+
# Yarn Integrity file
69+
.yarn-integrity
70+
71+
# dotenv environment variables file
72+
.env
73+
.env.test
74+
75+
# parcel-bundler cache (https://parceljs.org/)
76+
.cache
77+
78+
# Next.js build output
79+
.next
80+
81+
# Nuxt.js build / generate output
82+
.nuxt
83+
dist
84+
85+
# Gatsby files
86+
.cache/
87+
# Comment in the public line in if your project uses Gatsby and *not* Next.js
88+
# https://nextjs.org/blog/next-9-1#public-directory-support
89+
# public
90+
91+
# vuepress build output
92+
.vuepress/dist
93+
94+
# Serverless directories
95+
.serverless/
96+
97+
# FuseBox cache
98+
.fusebox/
99+
100+
# DynamoDB Local files
101+
.dynamodb/
102+
103+
# TernJS port file
104+
.tern-port

‎.prettierrc.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"printWidth": 80,
3+
"tabWidth": 2,
4+
"useTabs": false,
5+
"semi": false,
6+
"singleQuote": false,
7+
"quoteProps": "consistent",
8+
"trailingComma": "none",
9+
"bracketSpacing": true,
10+
"bracketSameLine": false,
11+
"arrowParens": "avoid"
12+
}

‎.vscode/extensions.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"recommendations": [
3+
"streetsidesoftware.code-spell-checker",
4+
"eamodio.gitlens",
5+
"esbenp.prettier-vscode",
6+
"psioniq.psi-header",
7+
"dbaeumer.vscode-eslint",
8+
"yzhang.markdown-all-in-one"
9+
]
10+
}

‎.vscode/settings.json‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"editor.detectIndentation": true,
3+
"editor.defaultFormatter": "esbenp.prettier-vscode",
4+
"editor.formatOnSave": true,
5+
"editor.rulers": [100],
6+
"typescript.enablePromptUseWorkspaceTsdk": true,
7+
"typescript.tsdk": "./node_modules/typescript/lib",
8+
"psi-header.templates": [
9+
{
10+
"language": "*",
11+
"template": [" Copyright <<year>> <<company>>"]
12+
}
13+
],
14+
"psi-header.config": {
15+
"company": "MFB Technologies, Inc.",
16+
"forceToTop": true,
17+
"blankLinesAfter": 1
18+
},
19+
"psi-header.changes-tracking": {
20+
"isActive": true,
21+
"enforceHeader": true,
22+
"excludeGlob": [
23+
"**/settings.json",
24+
"**/.gitignore",
25+
"**/.env*",
26+
"**/*.yml",
27+
"**/Dockerfile",
28+
"**/*.config.js",
29+
"**/*.config.*.js"
30+
],
31+
"exclude": ["jsonc", "json", "markdown"]
32+
},
33+
"psi-header.lang-config": [
34+
{
35+
"language": ".js",
36+
"begin": "",
37+
"end": "",
38+
"prefix": "//",
39+
"beforeHeader": ["#!/usr/bin/env node"]
40+
},
41+
{
42+
"language": ".ts",
43+
"begin": "",
44+
"end": "",
45+
"prefix": "//"
46+
},
47+
{
48+
"language": ".sh",
49+
"begin": "",
50+
"end": "",
51+
"prefix": "#",
52+
"beforeHeader": ["#!/usr/bin/env bash"]
53+
}
54+
],
55+
"search.exclude": {
56+
"**/node_modules": true,
57+
"**/dist": true,
58+
"**/coverage": true
59+
},
60+
"editor.tabSize": 2,
61+
"markdown.updateLinksOnFileMove.enableForDirectories": true,
62+
"markdown.editor.pasteUrlAsFormattedLink.enabled": "never",
63+
"markdown.editor.updateLinksOnPaste.enabled": false
64+
}

‎CHANGELOG.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"name": "@mfbtech/changelog-generator",
3+
"entries": [
4+
{
5+
"version": "1.0.0",
6+
"date": "Fri, 10 Jan 2025 20:40:53 GMT",
7+
"comments": {
8+
"NONE": [
9+
{
10+
"comment": ""
11+
}
12+
]
13+
}
14+
}
15+
]
16+
}

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Changelog - @mfbtech/changelog-generator
2+
3+
This log was last generated on Fri, 10 Jan 2025 20:40:53 GMT and should not be manually modified.
4+
5+
## 1.0.0
6+
7+
Fri, 10 Jan 2025 20:40:53 GMT
8+
9+
Version update only.

‎DOCKER.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Docker
2+
3+
1. Generate an SSH key and add it to GitHub.
4+
1. Clone the repository.
5+
1. Run `eval "$(ssh-agent)"`.
6+
1. Run `ssh-add`.
7+
1. Run `docker build --ssh default -t mfb-changelog-generator-dev-env .`.
8+
1. Run `docker create --mount type=bind,src=${HOME}/.ssh,target=/home/vscode/.ssh --name mfb-changelog-generator-dev-env-active -h mfb-changelog-generator-dev-env -it mfb-changelog-generator-dev-env`.
9+
1. Install the "Remote Development" extension pack in VS Code.
10+
1. Navigate to Remote Explorer in the VSCode sidebar.
11+
1. Select Containers from the drop down at the top.
12+
1. Attach to the new container.
13+
1. Click Open Folder and open `~/workspace/changelog-generator`.

0 commit comments

Comments
 (0)