Merge branch 'release/1.0.0-alpha.4'

Author: nekofar

.eslintrc.json

@@ -1,3 +1,3 @@
 {
-  "extends": "next/core-web-vitals"
+  "extends": ["next/core-web-vitals", "prettier"]
 }

.github/dependabot.yml

@@ -1,51 +1,51 @@
 version: 2
 updates:
   # Maintain dependencies for GitHub Actions
-  - package-ecosystem: "github-actions"
+  - package-ecosystem: 'github-actions'
     # Files stored in repository root
-    directory: "/"
+    directory: '/'
     # Check for updates every weekday
     schedule:
-      interval: "daily"
+      interval: 'daily'
     # Add assignees
     assignees:
-      - "nekofar"
+      - 'nekofar'
     # Include a list of updated dependencies
     commit-message:
-      prefix: "ci"
-      include: "scope"
+      prefix: 'ci'
+      include: 'scope'
     # Specify labels for pull requests
     labels:
-      - "dependencies"
+      - 'dependencies'
     # Allow up to 20 open pull requests for dependencies
     open-pull-requests-limit: 20
     # Add reviewers
     reviewers:
-      - "nekofar"
+      - 'nekofar'
     # Raise pull requests against the `develop` branch
-    target-branch: "develop"
+    target-branch: 'develop'
 
   # Maintain dependencies for PNPM
-  - package-ecosystem: "npm"
+  - package-ecosystem: 'npm'
     # Files stored in repository root
-    directory: "/"
+    directory: '/'
     # Check for updates every weekday
     schedule:
-      interval: "daily"
+      interval: 'daily'
     # Add assignees
     assignees:
-      - "nekofar"
+      - 'nekofar'
     # Include a list of updated dependencies
     commit-message:
-      prefix: "chore"
-      include: "scope"
+      prefix: 'chore'
+      include: 'scope'
     # Specify labels for pull requests
     labels:
-      - "dependencies"
+      - 'dependencies'
     # Allow up to 10 open pull requests for dependencies
     open-pull-requests-limit: 20
     # Add reviewers
     reviewers:
-      - "nekofar"
+      - 'nekofar'
     # Raise pull requests against the `develop` branch
-    target-branch: "develop"
+    target-branch: 'develop'

.github/workflows/build.yml

@@ -1,37 +1,37 @@
 name: Build Pipeline # A Build Pipeline which will use for build, test and deploy.
 
 on:
-  push:  # When we push the changes.
-    branches:  # Only for these branches.
+  push: # When we push the changes.
+    branches: # Only for these branches.
       - master
       - bugfix/*
       - hotfix/*
       - release/*
-    paths-ignore:  # Ignoring the markdown file changes.
-      - "**/*.md"
-  pull_request:  # Also on pull request events.
-  workflow_dispatch:  # Allows you to run this workflow manually from the Actions tab.
+    paths-ignore: # Ignoring the markdown file changes.
+      - '**/*.md'
+  pull_request: # Also on pull request events.
+  workflow_dispatch: # Allows you to run this workflow manually from the Actions tab.
 
 jobs:
-  build:  # Job named 'build'
-    runs-on: ubuntu-latest  # The type of machine to run the job on.
+  build: # Job named 'build'
+    runs-on: ubuntu-latest # The type of machine to run the job on.
 
-    strategy:  # Allows you to create a matrix for job configuration.
+    strategy: # Allows you to create a matrix for job configuration.
       matrix:
-        node-version: [ 18.x, 19.x, 20.x ]  # Running tests across different environments.
+        node-version: [18.x, 19.x, 20.x] # Running tests across different environments.
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
-    steps:  # The sequence of tasks that make up a job.
+    steps: # The sequence of tasks that make up a job.
       - name: Checking out repository code
-        uses: actions/[email protected]  # Action for checking out a repo.
+        uses: actions/[email protected] # Action for checking out a repo.
 
       - name: Setup Node.js ${{ matrix.node-version }} Environment
-        uses: actions/[email protected]  # Action for setting up Node environment.
+        uses: actions/[email protected] # Action for setting up Node environment.
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Install pnpm package manager
-        uses: pnpm/[email protected]  # Action for setting up pnpm.
+        uses: pnpm/[email protected] # Action for setting up pnpm.
         id: pnpm-install
         with:
           version: ^8
@@ -43,19 +43,19 @@ jobs:
           echo "pnpm_cache_dir=$(pnpm store path)" >> $GITHUB_OUTPUT
 
       - name: Cache pnpm Store
-        uses: actions/[email protected]  # Action provides caching dependencies and build outputs to improve workflow execution time.
+        uses: actions/[email protected] # Action provides caching dependencies and build outputs to improve workflow execution time.
         with:
-          path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}  # The path of the directory to cache.
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}  # An explicit key for restoring and saving the cache.
+          path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }} # The path of the directory to cache.
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }} # An explicit key for restoring and saving the cache.
           restore-keys: |
             ${{ runner.os }}-pnpm-store-
 
       - name: Install project dependencies
-        run: pnpm install  # Install all project dependencies.
+        run: pnpm install # Install all project dependencies.
 
       - name: Build & export the App
-        run: pnpm run build  # Builds the app and exports it.
+        run: pnpm run build # Builds the app and exports it.
 
-concurrency:  # Allows controlling the concurrency level of the job in the build pipeline.
+concurrency: # Allows controlling the concurrency level of the job in the build pipeline.
   group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true  # If enabled, previous runs of this workflow for the same group-key will be cancelled while this build or run is in progress.
+  cancel-in-progress: true # If enabled, previous runs of this workflow for the same group-key will be cancelled while this build or run is in progress.

.github/workflows/release.yml

@@ -9,7 +9,6 @@ on:
 
 jobs:
   release:
-
     # Specify the type of the runner the job will run on
     runs-on: ubuntu-latest
 

.prettierignore

@@ -0,0 +1,46 @@
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+pnpm-lock.yaml
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+/out
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+# next-sitemap
+**/robots.txt
+**/sitemap*.xml
+
+# lingui
+**/locales/
+
+# markdown
+CHANGELOG.md

CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.0-alpha.4] - 2023-07-21
+
+### <!-- 04 -->Refactor
+
+- Update `getStaticProps` and `getStaticPaths` functions
+- Update `locales` module for code consistency
+- Update code for better readability and consistency
+
+### <!-- 05 -->Documentation
+
+- Remove unnecessary whitespace from README
+
+### <!-- 08 -->Miscellaneous Tasks
+
+- Update lingui configuration
+- Add Prettier and its plugins for code formatting
+- Add `prettier.config.js` for unified formatting
+- Add Prettier to ESLint configuration
+- Add `.prettierignore` file to exclude unnecessary directories and files from formatting
+- Standardize quotes in YAML files
+- Update config files for consistent quote usage
+- Add prettier `format` script to `package.json`
+
 ## [1.0.0-alpha.3] - 2023-07-21
 
 ### <!-- 08 -->Miscellaneous Tasks

README.md

@@ -1,4 +1,3 @@
-
 ## Getting Started
 
 First, run the development server:

lingui.config.js

@@ -1,12 +1,13 @@
 /** @type {import('@lingui/conf').LinguiConfig} */
 module.exports = {
-    locales: ["ar", "en", "fa"],
-    sourceLocale: "en",
-    catalogs: [
-        {
-            path: "src/locales/{locale}/messages",
-            include: ["src"],
-        },
-    ],
-    format: "po",
-};
+  locales: ['ar', 'en', 'fa'],
+  sourceLocale: 'en',
+  catalogs: [
+    {
+      path: '<rootDir>/src/locales/{locale}/messages',
+      include: ['<rootDir>/src'],
+      exclude: ['**/node_modules/**', '**/.next/**', '**/out/**'],
+    },
+  ],
+  format: 'po',
+}

next.config.js

@@ -8,7 +8,7 @@ const nextConfig = {
   experimental: {
     swcPlugins: [
       [
-        "@lingui/swc-plugin",
+        '@lingui/swc-plugin',
         {
           // the same options as in .swcrc
         },

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nextjs-lingui-starter",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.4",
   "private": true,
   "scripts": {
     "dev": "next dev",
@@ -10,7 +10,8 @@
     "start": "serve out",
     "lint": "next lint",
     "lingui:extract": "lingui extract --clean",
-    "lingui:compile": "lingui compile"
+    "lingui:compile": "lingui compile",
+    "format": "prettier --write ."
   },
   "dependencies": {
     "@lingui/core": "4.3.0",
@@ -31,7 +32,11 @@
     "autoprefixer": "10.4.14",
     "eslint": "8.45.0",
     "eslint-config-next": "13.4.11",
+    "eslint-config-prettier": "8.8.0",
     "postcss": "8.4.26",
+    "prettier": "3.0.0",
+    "prettier-plugin-organize-imports": "3.2.3",
+    "prettier-plugin-tailwindcss": "0.4.1",
     "tailwindcss": "3.3.3",
     "typescript": "5.1.6",
     "serve": "14.2.0"