diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index d5cc870..0000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,62 +0,0 @@ -version: 2.1 - -orbs: - node: circleci/node@5.1 - coveralls: kaze/coveralls@1.0.1 - -jobs: - cov-korean: - docker: - - image: cimg/node:16.10 - steps: - - checkout - - node/install-packages: - pkg-manager: npm - - run: - name: Generate coverage - command: npx nx run @romanize/korean:coverage - - coveralls/upload: - parallel: true - path_to_lcov: ./packages/korean/coverage/lcov.info - flag_name: Korean - verbose: true - filepath: ./packages/korean/ - cov-done: - docker: - - image: cimg/node:16.10 - steps: - - coveralls/upload: - parallel_finished: true - deploy-korean: - docker: - - image: cimg/node:16.10 - steps: - - checkout - - node/install-packages: - pkg-manager: npm - - run: - name: Deploy to NPM - command: npx nx run @romanize/korean:deploy - -workflows: - cov-gen: - jobs: - - cov-korean: - filters: - branches: - only: - - main - - cov-done: - requires: - - cov-korean - filters: - branches: - only: - - main - npm-korean: - jobs: - - deploy-korean: - filters: - branches: - only: - - main diff --git a/.coveralls.yml b/.coveralls.yml deleted file mode 100644 index 3c2019c..0000000 --- a/.coveralls.yml +++ /dev/null @@ -1 +0,0 @@ -repo_token: 7RXrRR79E0ESR6cAje4ZyYhT5IoRTJyA0 \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..d421e28 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,48 @@ +on: + pull_request: + branches: + - main + - stage + push: + branches: + - main + - stage + +name: Test Coveralls + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + project: + - korean + steps: + - uses: actions/checkout@v1 + - name: Use Node.js 16.x + uses: actions/setup-node@v3 + with: + node-version: 16.x + - name: npm install + run: npm install + - name: Test ${{ matrix.project }} + run: npx nx run @romanize/${{ matrix.project }}:coverage + - name: Coveralls + uses: coverallsapp/github-action@v2 + with: + base-path: packages/${{ matrix.project }} + parallel: true + flag-name: ${{ matrix.project }} + + finish: + needs: test + if: ${{ always() }} + runs-on: ubuntu-latest + steps: + - name: Coveralls finished + uses: coverallsapp/github-action@v2 + with: + parallel-finished: true + + + \ No newline at end of file diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..434f3a6 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,24 @@ +on: + push: + branches: + - main + +name: Publish package to NPM + +jobs: + deploy: + runs-on: ubuntu-latest + strategy: + matrix: + project: + - korean + steps: + - uses: actions/checkout@v1 + - name: Use Node.js 16.x + uses: actions/setup-node@v3 + with: + node-version: 16.x + - name: npm install + run: npm install + - name: Deploy to NPM + run: npx nx run @romanize/${{ matrix.project }}:deploy \ No newline at end of file diff --git a/packages/cli/package.json b/packages/cli/package.json index 4bfe6b8..f94ece0 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,8 +1,9 @@ { "name": "@romanize/cli", - "version": "0.1.0", + "version": "0.1.1", "description": "CLI for romanize utilities", "main": "dist/index.js", + "types": "dist/index.d.ts", "bin": { "romanize": "dist/index.js" }, diff --git a/packages/core/package.json b/packages/core/package.json new file mode 100644 index 0000000..050a024 --- /dev/null +++ b/packages/core/package.json @@ -0,0 +1,20 @@ +{ + "name": "@romanize/core", + "version": "0.1.0", + "description": "Core utilities for romanize packages", + "main": "dist/index.js", + "types": "dist/index.d.ts", + "files": [ + "dist/", + "package.json" + ], + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "Kenneth Tang", + "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/Kenny477/romanize" + } +} diff --git a/packages/japanese/constants/systems/hepburn.ts b/packages/japanese/constants/systems/hepburn.ts new file mode 100644 index 0000000..e69de29 diff --git a/packages/japanese/constants/unicode.ts b/packages/japanese/constants/unicode.ts new file mode 100644 index 0000000..e69de29 diff --git a/packages/japanese/index.ts b/packages/japanese/index.ts new file mode 100644 index 0000000..e69de29 diff --git a/packages/japanese/package.json b/packages/japanese/package.json new file mode 100644 index 0000000..060b7ac --- /dev/null +++ b/packages/japanese/package.json @@ -0,0 +1,27 @@ +{ + "name": "@romanize/japanese", + "version": "0.1.0", + "description": "Romanize Japanese Hiragana, Katakana, and Kanji", + "main": "dist/index.js", + "scripts": { + "test": "jest" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/Kenny477/romanize.git" + }, + "keywords": [ + "japanese", + "hiragana", + "katakana", + "kanji", + "romanization", + "hepburn" + ], + "author": "Kenneth Tang", + "license": "MIT", + "bugs": { + "url": "https://github.com/Kenny477/romanize/issues" + }, + "homepage": "https://github.com/Kenny477/romanize#readme" +} diff --git a/packages/korean/__tests__/romanize.test.ts b/packages/korean/__tests__/romanize.test.ts index 9e7b9a7..ae7feaa 100644 --- a/packages/korean/__tests__/romanize.test.ts +++ b/packages/korean/__tests__/romanize.test.ts @@ -1,4 +1,4 @@ -import { romanize } from "../index"; +import { RomanizationSystem, romanize } from "../index"; test('romanizeHangul1', () => { expect(romanize('훌')).toEqual('hul'); @@ -12,14 +12,47 @@ test('romanizeHangul1', () => { eoneusae yeoreum jina gaeul`); }) -const tests = { - "안녕하세요": "annyeonghaseyo", - "안녕": "annyeong", - "안녕하십니까": "annyeonghasimnikka", - "좋고": "joko", - "놓다": "nota", - "잡혀": "japyeo", - "낳지": "nachi", +const tests: Record> = { + "안녕하세요": { + [RomanizationSystem.REVISED]: "annyeonghaseyo", + [RomanizationSystem.MCCUNE]: "annyŏnghaseyo", + [RomanizationSystem.YALE]: "annyenghaseyyo", + }, + "안녕": { + [RomanizationSystem.REVISED]: "annyeong", + [RomanizationSystem.MCCUNE]: "annyŏng", + [RomanizationSystem.YALE]: "annyeng", + }, + "안녕하십니까": { + [RomanizationSystem.REVISED]: "annyeonghasimnikka", + [RomanizationSystem.MCCUNE]: "annyŏnghasimnikka", + [RomanizationSystem.YALE]: "annyenghasipnikka", + }, + // "좋고": { + // [RomanizationSystem.REVISED]: "joko", + // [RomanizationSystem.MCCUNE]: "chok'o", + // [RomanizationSystem.YALE]: "cohko", + // }, + // "놓다": { + // [RomanizationSystem.REVISED]: "nota", + // [RomanizationSystem.MCCUNE]: "not'a", + // [RomanizationSystem.YALE]: "nohta", + // }, + // "잡혀": { + // [RomanizationSystem.REVISED]: "japyeo", + // [RomanizationSystem.MCCUNE]: "chap'yŏ", + // [RomanizationSystem.YALE]: "caphye", + // }, + // "낳지": { + // [RomanizationSystem.REVISED]: "nachi", + // [RomanizationSystem.MCCUNE]: "nach'i", + // [RomanizationSystem.YALE]: "nahci", + // }, + // "김치": { + // [RomanizationSystem.REVISED]: "gimchi", + // [RomanizationSystem.MCCUNE]: "kimch'i", + // [RomanizationSystem.YALE]: "kimchi", + // }, // "학여울": "hangnyeoul", // "알약": "allyak", // "백마": "baengma", @@ -33,6 +66,12 @@ const tests = { test('romanizeHangul2', () => { for (const [hangul, romanized] of Object.entries(tests)) { - expect(romanize(hangul)).toEqual(romanized); + for (const system of Object.values(RomanizationSystem)) { + expect(romanize(hangul, { system })).toEqual(romanized[system]); + } } -}) \ No newline at end of file +}) + +test('romanizeNotHangul', () => { + expect(() => romanize("我")).toThrowError('Not a Hangul string'); +}); \ No newline at end of file diff --git a/packages/korean/package.json b/packages/korean/package.json index b1c9260..6ab1777 100644 --- a/packages/korean/package.json +++ b/packages/korean/package.json @@ -1,18 +1,21 @@ { "name": "@romanize/korean", - "version": "0.1.1", + "version": "0.1.2", "description": "Romanize Korean Hangul", "main": "dist/index.js", + "types": "dist/index.d.ts", "files": [ "dist/", "package.json" ], "scripts": { - "build": "npm run clean && tsc --outDir dist", + "prebuild": "npm run clean && tsc --noEmit", + "build": "esbuild index.ts --bundle --minify --sourcemap --outdir=dist", "clean": "rimraf dist", "test": "jest", "coverage": "jest --coverage --ci", - "deploy": "npm run build && npm publish --access public" + "predeploy": "npm run build", + "deploy": "npm publish --access public" }, "author": "Kenneth Tang", "license": "MIT", diff --git a/packages/korean/tsconfig.json b/packages/korean/tsconfig.json index 6514bff..9ba11f5 100644 --- a/packages/korean/tsconfig.json +++ b/packages/korean/tsconfig.json @@ -1,104 +1,14 @@ { "compilerOptions": { - /* Visit https://aka.ms/tsconfig to read more about this file */ - - /* Projects */ - // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ - // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ - // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ - // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ - // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ - // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ - - /* Language and Environment */ - "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ - // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ - // "jsx": "preserve", /* Specify what JSX code is generated. */ - // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ - // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ - // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ - // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ - // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ - // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ - // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ - // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ - // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ - - /* Modules */ - "module": "commonjs", /* Specify what module code is generated. */ - // "rootDir": "./", /* Specify the root folder within your source files. */ - // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ - // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ - // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ - // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ - // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ - // "types": [], /* Specify type package names to be included without being referenced in a source file. */ - // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ - // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ - // "resolveJsonModule": true, /* Enable importing .json files. */ - // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ - - /* JavaScript Support */ - // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ - // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ - // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ - - /* Emit */ - // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ - // "declarationMap": true, /* Create sourcemaps for d.ts files. */ - // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ - // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ - // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ - // "outDir": "./", /* Specify an output folder for all emitted files. */ - // "removeComments": true, /* Disable emitting comments. */ - // "noEmit": true, /* Disable emitting files from a compilation. */ - // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ - // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ - // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ - // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ - // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ - // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ - // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ - // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ - // "newLine": "crlf", /* Set the newline character for emitting files. */ - // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ - // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ - // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ - // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ - // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ - // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ - - /* Interop Constraints */ - // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ - // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ - "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ - // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ - "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ - - /* Type Checking */ - "strict": true, /* Enable all strict type-checking options. */ - // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ - // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ - // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ - // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ - // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ - // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ - // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ - // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ - // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ - // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ - // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ - // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ - // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ - // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ - // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ - // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ - // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ - // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ - - /* Completeness */ - // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ - "skipLibCheck": true /* Skip type checking all .d.ts files. */ + "module": "ES6", + "target": "ES6", + "moduleResolution": "Node", + "declaration": true, + "declarationDir": "dist", + "outDir": "dist", + "strict": true, + "forceConsistentCasingInFileNames": true, + "esModuleInterop": true }, "include": [ "index.ts", diff --git a/packages/rest/package.json b/packages/rest/package.json index f674cd8..327c6a3 100644 --- a/packages/rest/package.json +++ b/packages/rest/package.json @@ -3,6 +3,7 @@ "version": "0.0.0", "description": "REST API for romanizations", "main": "index.js", + "types": "index.d.ts", "scripts": { "dev": "nodemon --exec ts-node index.ts", "test": "echo \"Error: no test specified\" && exit 1"