1.0.2 • Published 5 years ago
cogi v1.0.2
cogi
cogi is a simple JSON lint tool written by TypeScript If you have a lot of keys in JSON file, it can cause a mistake (To make a typo or to add a wrong key value) this lint tool will catch these errors
It searches all directories and files in the src directory to detect ts and tsx files and perform AST analysis.
Compares the argument value of the translation function t () extracted from AST with the key value of JSON files.
Installation
npm install cogi
Usage
// We plan to update, The translation function name must be fixed and used as t()
// example
funtion t(key: string){
return key
}
t('ko-item1')
t('ko-item2')
t('en-item1')
t('en-item2')
Directory Structure
// You need to keep these directory structures.
project
---locales
------en
---------translation.json
------ko
---------translation.json
---src
------exam
---------main.ts
---------router.ts
------build
---------main.js
---------router.js
------index.ts
------exam.tsx
In the src directory, when you create a directory or create a file, only the ts and tsx files are found and the argument values of t () are verified.
- provided API
import { getInfo, IInfo } from './ast'
import { getFiles, readData } from './files'
import { getTransInfoFromPath, ITranslation } from './translate'
CLI
Usage: cogi [options]
this is ts-lint tool for detect mistake in i18n
Options:
-V, --version output the version number
-h, --help output usage information
Limitations
// We plan to update, The translation function name must be fixed and used as t()