Merge pull request #16 from cjambrosi/feat/package-2

Feat/package 2

.eslintignore

@@ -1,6 +1,42 @@
-node_modules
-dist
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
 .next
-build
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel
+
+# changelog
+CHANGELOG.md
+
+# other folders
+dist
 public
-coverage

.github/pull_request_template.md

@@ -7,13 +7,11 @@
 [//]: <> (List the main changes made in this PR. It might be helpful to list important commits here.)
 
 <!--
-
 Example:
 
 - feat: description
 - fix: description
 - docs(readme): description
-
 -->
 
 ## Expected Behavior
@@ -39,7 +37,7 @@ Example:
 
 [//]: <> (Check the items as you complete the PR. This serves as a guide for you and reviewers.)
 
-- [ ] I have read all the [contribution](../CONTRIBUTING.md) requirements.
+- [ ] I have read all the [contribution](https://github.com/cjambrosi/ts-nextjs-boilerplate-starter/blob/main/CONTRIBUTING.md) requirements.
 - [ ] Updated the documentation (if necessary).
 - [ ] Commits follow the [conventional commits](https://www.conventionalcommits.org)
 - [ ] Removed dead code or unnecessary comments.

.github/workflows/lint.yml

@@ -0,0 +1,41 @@
+name: Code Check
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+
+concurrency:
+  group: ${{ github.job }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: ESLint, TypeScript, Prettier and Unit Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Download dependencies
+        uses: u0reo/npm-install@fix/restore-failure
+        with:
+          useRollingCache: true
+
+      - name: Lint
+        run: yarn lint:strict
+
+      - name: Type check
+        run: yarn typecheck
+
+      - name: Prettier check
+        run: yarn format:check
+
+      - name: Run jest
+        run: yarn test

.github/workflows/release-please.yml

@@ -0,0 +1,19 @@
+name: release-please
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        with:
+          release-type: node
+          package-name: release-please-action

.gitignore

@@ -37,5 +37,4 @@ yarn-error.log*
 next-env.d.ts
 
 # lock file
-*.lock
 *-lock.json

.prettierignore

@@ -1,6 +1,42 @@
-node_modules
-dist
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
 .next
-build
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel
+
+# changelog
+CHANGELOG.md
+
+# other folders
+dist
 public
-coverage

package.json

@@ -18,12 +18,16 @@
     "build": "next build",
     "start": "next start",
     "lint": "next lint",
-    "type-check": "tsc --pretty --noEmit",
+    "lint:fix": "eslint src --fix && yarn format",
+    "lint:strict": "eslint --max-warnings=0 src",
+    "typecheck": "tsc --pretty --noEmit",
     "test": "jest --maxWorkers=50% --silent",
     "test:unit": "jest --watch",
     "test:staged": "jest --maxWorkers=25% --bail --silent --coverage --coverageReporters=cobertura",
     "test:debug": "jest --no-cache --watch",
-    "test-all": "yarn lint && yarn type-check && yarn test",
+    "test-all": "yarn lint && yarn typecheck && yarn test",
+    "format": "prettier -w src",
+    "format:check": "prettier -c src",
     "prepare": "husky install",
     "pre-commit": "lint-staged"
   },
@@ -86,8 +90,12 @@
     "prettier": "^2.8.8"
   },
   "lint-staged": {
-    "src/**/*.{js,jsx,ts,tsx,json,css,scss,md}": [
-      "prettier --write"
+    "src/**/*.{js,jsx,ts,tsx}": [
+      "eslint --max-warnings=0",
+      "prettier -w"
+    ],
+    "**/*.{json,css,scss,md,webmanifest}": [
+      "prettier -w"
     ]
   }
 }

src/themes/styled.d.ts

@@ -12,11 +12,12 @@ interface IColorIntensity {
   strongLight?: string;
 }
 
+// TODO: Remove ignores
 declare module 'styled-components' {
   export interface DefaultTheme {
     id: string;
     name: tThemeName;
-    fonts: {};
+    fonts: any; // eslint-disable-line
     color: {
       black: IColorIntensity;
       white: IColorIntensity;

src/themes/theme.tsx

@@ -1,10 +1,16 @@
 import { DefaultTheme } from 'styled-components/dist/types';
 
+// TODO: Remove ignores
+// eslint-disable-next-line
+// @ts-ignore
 const lightTheme: DefaultTheme = {
   id: 'T_001',
   name: 'light'
 };
 
+// TODO: Remove ignores
+// eslint-disable-next-line
+// @ts-ignore
 const darkTheme: DefaultTheme = {
   id: 'T_002',
   name: 'dark'

src/utils/__tests__/getI18nLocales.test.ts

@@ -0,0 +1,10 @@
+import { getI18nLocales } from '@utils/getI18nLocales';
+
+describe('getI18nLocales', () => {
+  const mockLocales = [{ locale: 'pt-br' }, { locale: 'en' }];
+  it('Should return the correct locales list', () => {
+    const locales = getI18nLocales();
+
+    expect(locales).toEqual(mockLocales);
+  });
+});