chore(init): first commit reacti18n

.eslintignore

@@ -0,0 +1 @@
+.eslintrc.cjs

.eslintrc.cjs

@@ -0,0 +1,6 @@
+module.exports = {
+ extends: ['@hono/eslint-config'],
+ parserOptions: {
+ project: ['./tsconfig.json'],
+ },
+}

.gitattributes

@@ -0,0 +1,2 @@
+**/**.js linguist-vendored
+**/**.cjs linguist-vendored

.gitignore

@@ -0,0 +1,177 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Caches
+
+.cache
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store
+
+/dist

.prettierrc

@@ -0,0 +1,9 @@
+{
+ "printWidth": 100,
+ "trailingComma": "es5",
+ "tabWidth": 2,
+ "semi": false,
+ "singleQuote": true,
+ "jsxSingleQuote": true,
+ "endOfLine": "lf"
+}

LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Muhammad Fauzan <[email protected]> (https://fzn0x.dev)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,185 @@
+# 𝓡𝓮𝓪𝓬𝓽i18𝓷
+
+Straightforward & less effort React i18n library.
+
+## Get to Know
+
+- [Installation](#installation)
+- [Usage](#usage)
+ - [JavaScript](#javascript)
+ - [TypeScript](#typescript)
+ - [React](#react)
+- [License](#license)
+
+## Installation
+
+```sh
+bun install reacti18n
+npm install reacti18n
+yarn add reacti18n
+pnpm install reacti18n
+```
+
+## Usage
+
+Creates `lang.json` and `lang-admin.json` files:
+
+**`lang.json` :**
+
+```json
+{
+ "en": {
+ "hello": "hello world"
+ },
+ "de": {
+ "hello": "Guten Morgen"
+ },
+ "id": {
+ "hello": "Hallo bang"
+ }
+}
+```
+
+**`lang-admin.json` :**
+
+```json
+{
+ "en": {
+ "hello": "hello world from admin"
+ },
+ "de": {
+ "hello": "Guten Morgen from admin"
+ },
+ "id": {
+ "hello": "Hallo bang from admin"
+ }
+}
+```
+
+### JavaScript
+
+```js
+// lang.js
+const i18n = require('reacti18n')
+
+const t = i18n.init({
+ namespace: {
+ default: {
+ // user pages
+ load: `/lang.json`, // multiple files loads also
+ // supported: [`lang.json`, `lang-2.json`]
+ type: 'json', // json, sqlite
+ storage: 'path',
+ },
+ admin: {
+ // admin pages
+ load: `/lang-admin.json`, // multiple files loads also
+ // supported: [`lang-admin.json`, `lang-admin-2.json`]
+ type: 'json',
+ storage: 'cookie',
+ },
+ // otherCustomNamespace: {
+ // load: `/lang.db`,
+ // type: 'sqlite', // json, sqlite
+ // }
+ },
+ detection: {
+ order: ['cookie', 'path', 'query'], // use defaultLang if not found
+ defaultLang: 'en',
+ },
+})
+
+console.log(t('hello')) // "hello" from default namespace
+console.log(t('admin.hello')) // "hello" from admin namespace,
+// defaultLang: en if no language detected in cookie, path or query
+// for path: url must includes /en/ path or similar lang names like /de/ path to be recognized
+// for query: url must includes query params `?lang=en` to work,
+// or other similar lang names like `?lang=de` or `?lang=id` to work.
+// for cookie: you need to store cookie with name `lang` and with the value of current lang
+// name, for example: en, de, id
+
+// You can export for reusability
+// module.exports = t;
+```
+
+### TypeScript
+
+```js
+// lang.ts
+import i18n from 'reacti18n'
+
+const t = i18n.init({
+ namespace: {
+ default: {
+ // user pages
+ load: `/lang.json`,
+ type: 'json', // json, sqlite
+ storage: 'path',
+ },
+ admin: {
+ // admin pages
+ load: `/lang-admin.json`,
+ type: 'json',
+ storage: 'cookie',
+ },
+ // otherCustomNamespace: {
+ // load: `/lang.db`,
+ // type: 'sqlite', // json, sqlite
+ // }
+ },
+ detection: {
+ order: ['cookie', 'path', 'query'], // use defaultLang if not found
+ defaultLang: 'en',
+ },
+})
+
+console.log(t('hello')) // "hello" from default namespace
+console.log(t('admin.hello')) // "hello" from admin namespace,
+
+// You can export for reusability
+// export default t;
+```
+
+### React
+
+```jsx
+import i18n from 'reacti18n'
+
+const t = i18n.init({
+ namespace: {
+ default: {
+ // user pages
+ load: `/lang.json`,
+ type: 'json', // json, sqlite
+ storage: 'path',
+ },
+ admin: {
+ // admin pages
+ load: `/lang-admin.json`,
+ type: 'json',
+ storage: 'cookie',
+ },
+ // otherCustomNamespace: {
+ // load: `/lang.db`,
+ // type: 'sqlite', // json, sqlite
+ // }
+ },
+ detection: {
+ order: ['cookie', 'path', 'query'], // use defaultLang if not found
+ defaultLang: 'en',
+ },
+})
+
+// Creates a function LanguageSwitch to change defaultLang
+export default function LanguageSwitch({ lang, ns }) {
+ // t.switch is to change the defaultLang
+ return <div onClick={() => t.switch(lang, ns)}>Switch Language for {ns}</div>
+}
+
+;<LanguageSwitch lang='de' ns='default' />
+;<LanguageSwitch lang='de' ns='admin' />
+```
+
+## License
+
+Reacti18n is [MIT Licensed](./LICENSE) and Open Source Software by [@fzn0x](https://github.com/fzn0x)