feat: add prettier workflow (#2111)

* feat: add prettier workflow

* delete overrides

.github/stale.yml

@@ -1,19 +1,18 @@
-
 # Number of days of inactivity before an issue becomes stale
 daysUntilStale: 7
 # Number of days of inactivity before a stale issue is closed
 daysUntilClose: 7
 # Issues with these labels will never be considered stale
 exemptLabels:
-  - "discussion"
-  - "feature request"
-  - "bug"
-  - "breaking change"
-  - "doc"
-  - "issue"
-  - "help wanted"
-  - "good first issue"
-  - "pr hold"
+  - 'discussion'
+  - 'feature request'
+  - 'bug'
+  - 'breaking change'
+  - 'doc'
+  - 'issue'
+  - 'help wanted'
+  - 'good first issue'
+  - 'pr hold'
 # Label to use when marking an issue as stale
 staleLabel: stale
 # Comment to post when marking an issue as stale. Set to `false` to disable

.github/workflows/ci.yml

@@ -42,6 +42,9 @@ jobs:
       - name: Typecheck
         run: npm run typecheck
 
+      - name: Prettier
+        run: npm run prettier
+
       - name: Unit tests
         run: npm test
 

CHANGELOG.md

@@ -60,7 +60,6 @@
 If you're experiencing typecheck errors regarding keys: ensure `i18next` is at least `^22.4.3` in your
 package.json (then run install), see [#2058](https://github.com/i18next/next-i18next/pull/2058).
 
-
 ## 13.0.0
 
 The v13.0.0 release is a major version to improve stability and general experience.

README.md

@@ -234,7 +234,7 @@ module.exports = {
     typeof window === 'undefined'
       ? require('path').resolve('./my-custom/path')
       : '/public/my-custom/path',
-  ns: ['common']
+  ns: ['common'],
 }
 ```
 
@@ -339,6 +339,7 @@ For example, if you want to use `{` and `}` the config would look like this:
 If you want to change the default config path, you can set the environment variable `I18NEXT_DEFAULT_CONFIG_PATH`.
 
 For example, inside the `.env` file you can set a static path:
+
 ```
 I18NEXT_DEFAULT_CONFIG_PATH=/path/to/project/apps/my-app/next-i18next.config.js
 ```
@@ -403,7 +404,6 @@ But there's a way to workaround that with the help of [next-language-detector](h
 Check out [this blog post](https://locize.com/blog/next-i18n-static/) and [this example project](./examples/ssg/).
 [![](https://locize.com/blog/next-i18n-static/title.jpg)](https://locize.com/blog/next-i18n-static/)
 
-
 ### Translate in child components
 
 You have multiple ways to use the t function in your child component:
@@ -413,7 +413,7 @@ You have multiple ways to use the t function in your child component:
 3. Use the [`useTranslation`](https://react.i18next.com/latest/usetranslation-hook) function, like in this example: https://github.com/i18next/next-i18next/blob/e6b5085b5e92004afa9516bd444b19b2c8cf5758/examples/simple/components/Footer.tsx#L6
 4. Use the [`withTranslation`](https://react.i18next.com/latest/withtranslation-hoc) function
 
-*And in general, you always needs to be sure serverSideTranslations contains all namespaces you need in the tree.*
+_And in general, you always needs to be sure serverSideTranslations contains all namespaces you need in the tree._
 
 ## Contributors
 

examples/simple/components/Footer.tsx

@@ -17,7 +17,7 @@ export const Footer: FC = () => {
         }}
       >
         <Trans i18nKey="helpLocize" t={t}>
-          With using 
+          With using
           <a href="https://locize.com" target="_new">
             locize
           </a>

examples/simple/pages/index.tsx

@@ -37,7 +37,7 @@ const Homepage = (
             </h3>
             <p>
               <Trans i18nKey="blog.appDir.answer">
-                Then check out 
+                Then check out
                 <a href={t('blog.optimized.link')}>this blog post</a>
                 .
               </Trans>

package.json

@@ -36,6 +36,7 @@
     "locale"
   ],
   "scripts": {
+    "prettier": "prettier --ignore-path .gitignore --write .",
     "lint": "eslint src examples",
     "clean": "rm -rf ./examples/simple/.next ./examples/ssg/.next ./dist && mkdir dist",
     "build:es": "BABEL_ENV=es babel src --extensions '.ts,.tsx' --out-dir dist/es --copy-files",

prettier.config.js

@@ -6,13 +6,13 @@
 
 module.exports = {
   // These settings are duplicated in .editorconfig:
-  tabWidth: 2, // indent_size = 2
-  useTabs: false, // indent_style = space
+  arrowParens: 'avoid',
+  bracketSpacing: true,
   endOfLine: 'lf', // end_of_line = lf
+  printWidth: 69, // default: 80
   semi: false, // default: true
   singleQuote: true, // default: false
-  printWidth: 69, // default: 80
+  tabWidth: 2, // indent_size = 2
   trailingComma: 'es5',
-  bracketSpacing: true,
-  arrowParens: 'avoid',
+  useTabs: false, // indent_style = space
 }

src/config/createConfig.ts

@@ -52,12 +52,15 @@ export const createConfig = (
       [combinedConfig.fallbackLng] = locales
   }
 
-  const userPrefix = userConfig?.interpolation?.prefix;
-  const userSuffix = userConfig?.interpolation?.suffix;
-  const prefix = userPrefix ?? '{{';
-  const suffix = userSuffix ?? '}}';
-  if (typeof userConfig?.localeStructure !== 'string' && (userPrefix || userSuffix)) {
-    combinedConfig.localeStructure = `${prefix}lng${suffix}/${prefix}ns${suffix}`;
+  const userPrefix = userConfig?.interpolation?.prefix
+  const userSuffix = userConfig?.interpolation?.suffix
+  const prefix = userPrefix ?? '{{'
+  const suffix = userSuffix ?? '}}'
+  if (
+    typeof userConfig?.localeStructure !== 'string' &&
+    (userPrefix || userSuffix)
+  ) {
+    combinedConfig.localeStructure = `${prefix}lng${suffix}/${prefix}ns${suffix}`
   }
 
   const { fallbackLng, localeStructure } = combinedConfig
@@ -233,7 +236,10 @@ export const createConfig = (
           return unique(allNamespaces)
         }
 
-        if (localeStructure.indexOf(`${prefix}lng${suffix}`) > localeStructure.indexOf(`${prefix}ns${suffix}`)) {
+        if (
+          localeStructure.indexOf(`${prefix}lng${suffix}`) >
+          localeStructure.indexOf(`${prefix}ns${suffix}`)
+        ) {
           throw new Error(
             'Must provide all namespaces in ns option if using a localeStructure that is not namespace-listable like lng/ns'
           )

src/serverSideTranslations.ts

@@ -41,15 +41,14 @@ export const serverSideTranslations = async (
   let userConfig = configOverride
   const configPath = path.resolve(DEFAULT_CONFIG_PATH)
 
-  if (
-    !userConfig &&
-    fs.existsSync(configPath)
-  ) {
+  if (!userConfig && fs.existsSync(configPath)) {
     userConfig = await import(configPath)
   }
 
   if (userConfig === null) {
-    throw new Error(`next-i18next was unable to find a user config at ${configPath}`)
+    throw new Error(
+      `next-i18next was unable to find a user config at ${configPath}`
+    )
   }
 
   const config = createConfig({