diff --git a/README.md b/README.md index 72ac2ef..6c4e3b3 100644 --- a/README.md +++ b/README.md @@ -1,169 +1,5 @@ -# TypeScript library starter +# svelte-i18n -[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) -[![Greenkeeper badge](https://badges.greenkeeper.io/alexjoverm/typescript-library-starter.svg)](https://greenkeeper.io/) -[![Travis](https://img.shields.io/travis/alexjoverm/typescript-library-starter.svg)](https://travis-ci.org/alexjoverm/typescript-library-starter) -[![Coveralls](https://img.shields.io/coveralls/alexjoverm/typescript-library-starter.svg)](https://coveralls.io/github/alexjoverm/typescript-library-starter) -[![Dev Dependencies](https://david-dm.org/alexjoverm/typescript-library-starter/dev-status.svg)](https://david-dm.org/alexjoverm/typescript-library-starter?type=dev) -[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg)](https://paypal.me/AJoverMorales) +> Internationalization for svelte -A starter project that makes creating a TypeScript library extremely easy. - -![](https://i.imgur.com/opUmHp0.png) - -### Usage - -```bash -git clone https://github.com/alexjoverm/typescript-library-starter.git YOURFOLDERNAME -cd YOURFOLDERNAME - -# Run npm install and write your library name when asked. That's all! -npm install -``` - -**Start coding!** `package.json` and entry files are already set up for you, so don't worry about linking to your main file, typings, etc. Just keep those files with the same name. - -### Features - - - Zero-setup. After running `npm install` things will setup for you :wink: - - **[RollupJS](https://rollupjs.org/)** for multiple optimized bundles following the [standard convention](http://2ality.com/2017/04/setting-up-multi-platform-packages.html) and [Tree-shaking](https://alexjoverm.github.io/2017/03/06/Tree-shaking-with-Webpack-2-TypeScript-and-Babel/) - - Tests, coverage and interactive watch mode using **[Jest](http://facebook.github.io/jest/)** - - **[Prettier](https://github.com/prettier/prettier)** and **[TSLint](https://palantir.github.io/tslint/)** for code formatting and consistency - - **Docs automatic generation and deployment** to `gh-pages`, using **[TypeDoc](http://typedoc.org/)** - - Automatic types `(*.d.ts)` file generation - - **[Travis](https://travis-ci.org)** integration and **[Coveralls](https://coveralls.io/)** report - - (Optional) **Automatic releases and changelog**, using [Semantic release](https://github.com/semantic-release/semantic-release), [Commitizen](https://github.com/commitizen/cz-cli), [Conventional changelog](https://github.com/conventional-changelog/conventional-changelog) and [Husky](https://github.com/typicode/husky) (for the git hooks) - -### Importing library - -You can import the generated bundle to use the whole library generated by this starter: - -```javascript -import myLib from 'mylib' -``` - -Additionally, you can import the transpiled modules from `dist/lib` in case you have a modular library: - -```javascript -import something from 'mylib/dist/lib/something' -``` - -### NPM scripts - - - `npm t`: Run test suite - - `npm start`: Run `npm run build` in watch mode - - `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch) - - `npm run test:prod`: Run linting and generate coverage - - `npm run build`: Generate bundles and typings, create docs - - `npm run lint`: Lints code - - `npm run commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:) - -### Excluding peerDependencies - -On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in [Rollup docs](https://rollupjs.org/#peer-dependencies) how to do that. - -Good news: the setup is here for you, you must only include the dependency name in `external` property within `rollup.config.js`. For example, if you want to exclude `lodash`, just write there `external: ['lodash']`. - -### Automatic releases - -_**Prerequisites**: you need to create/login accounts and add your project to:_ - - [npm](https://www.npmjs.com/) - - [Travis CI](https://travis-ci.org) - - [Coveralls](https://coveralls.io) - -_**Prerequisite for Windows**: Semantic-release uses -**[node-gyp](https://github.com/nodejs/node-gyp)** so you will need to -install -[Microsoft's windows-build-tools](https://github.com/felixrieseberg/windows-build-tools) -using this command:_ - -```bash -npm install --global --production windows-build-tools -``` - -#### Setup steps - -Follow the console instructions to install semantic release and run it (answer NO to "Do you want a `.travis.yml` file with semantic-release setup?"). - -_Note: make sure you've setup `repository.url` in your `package.json` file_ - -```bash -npm install -g semantic-release-cli -semantic-release-cli setup -# IMPORTANT!! Answer NO to "Do you want a `.travis.yml` file with semantic-release setup?" question. It is already prepared for you :P -``` - -From now on, you'll need to use `npm run commit`, which is a convenient way to create conventional commits. - -Automatic releases are possible thanks to [semantic release](https://github.com/semantic-release/semantic-release), which publishes your code automatically on [github](https://github.com/) and [npm](https://www.npmjs.com/), plus generates automatically a changelog. This setup is highly influenced by [Kent C. Dodds course on egghead.io](https://egghead.io/courses/how-to-write-an-open-source-javascript-library) - -### Git Hooks - -There is already set a `precommit` hook for formatting your code with Prettier :nail_care: - -By default, there are two disabled git hooks. They're set up when you run the `npm run semantic-release-prepare` script. They make sure: - - You follow a [conventional commit message](https://github.com/conventional-changelog/conventional-changelog) - - Your build is not going to fail in [Travis](https://travis-ci.org) (or your CI server), since it's runned locally before `git push` - -This makes more sense in combination with [automatic releases](#automatic-releases) - -### FAQ - -#### `Array.prototype.from`, `Promise`, `Map`... is undefined? - -TypeScript or Babel only provides down-emits on syntactical features (`class`, `let`, `async/await`...), but not on functional features (`Array.prototype.find`, `Set`, `Promise`...), . For that, you need Polyfills, such as [`core-js`](https://github.com/zloirock/core-js) or [`babel-polyfill`](https://babeljs.io/docs/usage/polyfill/) (which extends `core-js`). - -For a library, `core-js` plays very nicely, since you can import just the polyfills you need: - -```javascript -import "core-js/fn/array/find" -import "core-js/fn/string/includes" -import "core-js/fn/promise" -... -``` - -#### What is `npm install` doing on first run? - -It runs the script `tools/init` which sets up everything for you. In short, it: - - Configures RollupJS for the build, which creates the bundles - - Configures `package.json` (typings file, main file, etc) - - Renames main src and test files - -#### What if I don't want git-hooks, automatic releases or semantic-release? - -Then you may want to: - - Remove `commitmsg`, `postinstall` scripts from `package.json`. That will not use those git hooks to make sure you make a conventional commit - - Remove `npm run semantic-release` from `.travis.yml` - -#### What if I don't want to use coveralls or report my coverage? - -Remove `npm run report-coverage` from `.travis.yml` - -## Resources - -- [Write a library using TypeScript library starter](https://dev.to/alexjoverm/write-a-library-using-typescript-library-starter) by [@alexjoverm](https://github.com/alexjoverm/) -- [📺 Create a TypeScript Library using typescript-library-starter](https://egghead.io/lessons/typescript-create-a-typescript-library-using-typescript-library-starter) by [@alexjoverm](https://github.com/alexjoverm/) -- [Introducing TypeScript Library Starter Lite](https://blog.tonysneed.com/2017/09/15/introducing-typescript-library-starter-lite/) by [@tonysneed](https://github.com/tonysneed) - -## Projects using `typescript-library-starter` - -Here are some projects that use `typescript-library-starter`: - -- [NOEL - A universal, human-centric, replayable event emitter](https://github.com/lifenautjoe/noel) -- [droppable - A library to give file dropping super-powers to any HTML element.](https://github.com/lifenautjoe/droppable) -- [redis-messaging-manager - Pubsub messaging library, using redis and rxjs](https://github.com/tomyitav/redis-messaging-manager) - -## Credits - -Made with :heart: by [@alexjoverm](https://twitter.com/alexjoverm) and all these wonderful contributors ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): - - - -| [
Ciro](https://www.linkedin.com/in/ciro-ivan-agulló-guarinos-42109376)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=k1r0s "Code") [🔧](#tool-k1r0s "Tools") | [
Marius Schulz](https://blog.mariusschulz.com)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=mariusschulz "Documentation") | [
Alexander Odell](https://github.com/alextrastero)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=alextrastero "Documentation") | [
Ryan Ham](https://github.com/superamadeus)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=superamadeus "Code") | [
Chi](https://consiiii.me)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=ChinW "Code") [🔧](#tool-ChinW "Tools") [📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=ChinW "Documentation") | [
Matt Mazzola](https://github.com/mattmazzola)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=mattmazzola "Code") [🔧](#tool-mattmazzola "Tools") | [
Sergii Lischuk](http://leefrost.github.io)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=Leefrost "Code") | -| :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| [
Steve Lee](http;//opendirective.com)
[🔧](#tool-SteveALee "Tools") | [
Flavio Corpa](http://flaviocorpa.com)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=kutyel "Code") | [
Dom](https://github.com/foreggs)
[🔧](#tool-foreggs "Tools") | [
Alex Coles](http://alexbcoles.com)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=myabc "Documentation") | [
David Khourshid](https://github.com/davidkpiano)
[🔧](#tool-davidkpiano "Tools") | [
Aarón García Hervás](https://aarongarciah.com)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=aarongarciah "Documentation") | [
Jonathan Hart](https://www.stuajnht.co.uk)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=stuajnht "Code") | -| [
Sanjiv Lobo](https://github.com/Xndr7)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=Xndr7 "Documentation") | [
Stefan Aleksovski](https://github.com/sAleksovski)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=sAleksovski "Code") | [
dev.peerapong](https://github.com/devpeerapong)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=devpeerapong "Code") | [
Aaron Groome](http://twitter.com/Racing5372)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=Racing5372 "Documentation") | [
Aaron Reisman](https://github.com/lifeiscontent)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=lifeiscontent "Code") | [
kid-sk](https://github.com/kid-sk)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=kid-sk "Documentation") | [
Andrea Gottardi](http://about.me/andreagot)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=AndreaGot "Documentation") | -| [
Yogendra Sharma](http://TechiesEyes.com)
[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=Yogendra0Sharma "Documentation") | [
Rayan Salhab](http://linkedin.com/in/rayan-salhab/)
[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=cyphercodes "Code") | - - -This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome! +**Work-in-progress** \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 846b74e..96e17e7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3377,13 +3377,15 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=", - "dev": true + "dev": true, + "optional": true }, "brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", "dev": true, + "optional": true, "requires": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -3400,19 +3402,22 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz", "integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=", - "dev": true + "dev": true, + "optional": true }, "concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", - "dev": true + "dev": true, + "optional": true }, "console-control-strings": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/console-control-strings/-/console-control-strings-1.1.0.tgz", "integrity": "sha1-PXz0Rk22RG6mRL9LOVB/mFEAjo4=", - "dev": true + "dev": true, + "optional": true }, "core-util-is": { "version": "1.0.2", @@ -3543,7 +3548,8 @@ "version": "2.0.3", "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=", - "dev": true + "dev": true, + "optional": true }, "ini": { "version": "1.3.5", @@ -3557,6 +3563,7 @@ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", "dev": true, + "optional": true, "requires": { "number-is-nan": "^1.0.0" } @@ -3573,6 +3580,7 @@ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", "dev": true, + "optional": true, "requires": { "brace-expansion": "^1.1.7" } @@ -3581,13 +3589,15 @@ "version": "0.0.8", "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz", "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=", - "dev": true + "dev": true, + "optional": true }, "minipass": { "version": "2.2.4", "resolved": "https://registry.npmjs.org/minipass/-/minipass-2.2.4.tgz", "integrity": "sha512-hzXIWWet/BzWhYs2b+u7dRHlruXhwdgvlTMDKC6Cb1U7ps6Ac6yQlR39xsbjWJE377YTCtKwIXIpJ5oP+j5y8g==", "dev": true, + "optional": true, "requires": { "safe-buffer": "^5.1.1", "yallist": "^3.0.0" @@ -3608,6 +3618,7 @@ "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz", "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=", "dev": true, + "optional": true, "requires": { "minimist": "0.0.8" } @@ -3696,7 +3707,8 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/number-is-nan/-/number-is-nan-1.0.1.tgz", "integrity": "sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0=", - "dev": true + "dev": true, + "optional": true }, "object-assign": { "version": "4.1.1", @@ -3710,6 +3722,7 @@ "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", "dev": true, + "optional": true, "requires": { "wrappy": "1" } @@ -3847,6 +3860,7 @@ "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", "dev": true, + "optional": true, "requires": { "code-point-at": "^1.0.0", "is-fullwidth-code-point": "^1.0.0", @@ -9782,6 +9796,12 @@ "integrity": "sha1-U10EXOa2Nj+kARcIRimZXp3zJMc=", "dev": true }, + "svelte": { + "version": "2.9.7", + "resolved": "https://registry.npmjs.org/svelte/-/svelte-2.9.7.tgz", + "integrity": "sha512-+OwyqaGgy25vKBmZOR7usUE4bK1sHnxvv+Q+8IXFZsanvR+acTjIL+GRdRS8XRvoaxfxM47DpwWk1wo4RV0ucg==", + "dev": true + }, "symbol-observable": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/symbol-observable/-/symbol-observable-1.2.0.tgz", diff --git a/package.json b/package.json index 692e510..1ff78af 100644 --- a/package.json +++ b/package.json @@ -99,6 +99,7 @@ "rollup-plugin-sourcemaps": "^0.4.2", "rollup-plugin-typescript2": "^0.11.1", "semantic-release": "^15.0.0", + "svelte": "^2.9.7", "ts-jest": "^22.0.0", "ts-node": "^6.0.0", "tslint": "^5.8.0", diff --git a/src/interfaces.ts b/src/interfaces.ts index 7ac40ab..c4edf03 100644 --- a/src/interfaces.ts +++ b/src/interfaces.ts @@ -11,3 +11,20 @@ export interface Sveltei18n { upper: TranslationGetter lower: TranslationGetter } +export interface SvelteEventListener { + cancel(): void +} + +export interface SvelteStore { + on: (event: string, callback: Function) => SvelteEventListener + set: (newState: Object) => void + fire: (event: string, value: any) => void + [prop: string]: any +} + +export interface Locale { + [id: string | number]: string +} +export interface Locales { + [locale: string]: Locale +} diff --git a/src/svelte-i18n.ts b/src/svelte-i18n.ts index 909df4e..1ddfa52 100644 --- a/src/svelte-i18n.ts +++ b/src/svelte-i18n.ts @@ -1,18 +1,19 @@ -import { InterpolationObj, Sveltei18n } from './interfaces' +import { InterpolationObj, Sveltei18n, SvelteStore, Locale, Locales } from './interfaces' +import { capitalize, titlelize, upper, lower, getNestedProp } from './utils' -export default function() { - const _ = function(str: string, values: InterpolationObj) { - return str - } +export default function(store: SvelteStore, locales: Locales) { + store.locale = (locale: string) => store.fire('locale', locale) + store.on('locale', function(locale: string) { + const localeDict: Locale = locales[locale] + const _ = function(id, values) { + return getNestedProp(localeDict, id) || id + } - Object.assign(_, { - capitalize: (id: string, values: InterpolationObj) => - _(id, values).replace(/(^|\s)\S/, l => l.toUpperCase()), - titlelize: (id: string, values: InterpolationObj) => - _(id, values).replace(/(^|\s)\S/g, l => l.toUpperCase()), - upper: (id: string, values: InterpolationObj) => _(id, values).toLocaleUpperCase(), - lower: (id: string, values: InterpolationObj) => _(id, values).toLocaleLowerCase() + _.capitalize = (id, values) => capitalize(_(id, values)) + _.titlelize = (id, values) => titlelize(_(id, values)) + _.upper = (id, values) => upper(_(id, values)) + _.lower = (id, values) => lower(_(id, values)) + + store.set({ locale, _ }) }) - - return _ } diff --git a/src/utils.ts b/src/utils.ts new file mode 100644 index 0000000..c316052 --- /dev/null +++ b/src/utils.ts @@ -0,0 +1,18 @@ +export const capitalize = (str: string) => str.replace(/(^|\s)\S/, l => l.toUpperCase()) +export const titlelize = (str: string) => str.replace(/(^|\s)\S/g, l => l.toUpperCase()) +export const upper = (str: string) => str.toLocaleUpperCase() +export const lower = (str: string) => str.toLocaleLowerCase() + +export const getNestedProp = (obj: { [prop: string]: any }, path: string) => { + try { + return path + .replace('[', '.') + .replace(']', '') + .split('.') + .reduce(function(o, property) { + return o[property] + }, obj) + } catch (err) { + return undefined + } +} diff --git a/test/svelte-i18n.test.ts b/test/svelte-i18n.test.ts index 42aefb0..4b69218 100644 --- a/test/svelte-i18n.test.ts +++ b/test/svelte-i18n.test.ts @@ -1,14 +1,51 @@ -import DummyClass from '../src/svelte-i18n' +import i18n from '../src/svelte-i18n' +import { Store } from 'svelte/store.umd' +import { capitalize, titlelize, upper, lower, getNestedProp } from '../src/utils' + +const store = new Store() +const locales = { + 'pt-br': { + test: 'teste', + phrase: 'Adoro banana', + phrases: ['Frase 1', 'Frase 2'] + }, + po: { + test: 'prøve', + phrase: 'Jeg elsker banan', + phrases: ['sætning 1', 'sætning 2'] + } +} + +i18n(store, locales) /** * Dummy test */ -describe('Dummy test', () => { - it('works if true is truthy', () => { - expect(true).toBeTruthy() - }) - - it('DummyClass is instantiable', () => { - expect(new DummyClass()).toBeInstanceOf(DummyClass) +describe('utils', () => { + it('works', () => { + expect(getNestedProp(store['pt-br'], 'phrases[3]')).toBe(undefined) + }) +}) +describe('Dummy test', () => { + it('works if true is truthy', () => { + expect(store.get().locale).toBeFalsy() + expect(store.get()._).toBeFalsy() + + store.fire('locale', 'en') + expect(store.get().locale).toBe('en') + store.locale('pt-br') + expect(store.get().locale).toBe('pt-br') + expect(store.get()._).toBeInstanceOf(Function) + expect(store.get()._('non-existent')).toBe('non-existent') + expect(store.get()._('test')).toBe(locales['pt-br'].test) + store.fire('locale', 'po') + expect(store.get()._('test')).not.toBe(locales['pt-br'].test) + expect(store.get()._('test')).toBe(locales.po.test) + expect(store.get()._('phrases[1]')).toBe(locales.po.phrases[1]) + expect(store.get()._('phrases[2]')).toBe('phrases[2]') + expect(store.get()._.capitalize('phrase')).toBe(capitalize(locales.po.phrase)) + expect(store.get()._.titlelize('phrase')).toBe(titlelize(locales.po.phrase)) + expect(store.get()._.upper('phrase')).toBe(upper(locales.po.phrase)) + expect(store.get()._.lower('phrase')).toBe(lower(locales.po.phrase)) }) })