chore: switch to TypeScript #218

KingDarBoja · 2020-12-12T18:28:35Z

This is a work in progress. References #176

Changelog:

Switch to TypeScript.
Move type definitions into types.ts file.
Remove old index.d.ts file and set compiler flag to autogenerate those from src.
Manage to fix the localeFilter type definitions ~~(Need some help here!)~~ casted in the meantime 🧙 .
Setup Mocha to use ts-node/register.
Setup ESLint + TS + Prettier.
Cleanup install (I used yarn so looks like it should be npm instead).
Converted JSON files into TS files for tree-shaking.

KingDarBoja · 2020-12-12T19:06:08Z

Would like some review from @danilofuchs as well :D

danilofuchs

Awesome initiative and great job!

The Typescript build is failing on a few places, please take a look at them.

.eslintrc

danilofuchs · 2020-12-12T20:29:28Z

@michaelwittig currently on getAlpha3Code, getName, etc. when the lib cannot find the corresponding country, it returns undefined.

This is currently not expressed with the current index.d.ts file.

So, this PR also fixes #184 and closes #198

I would suggest returning null instead of undefined, but that would introduce a breaking change, so it may not be suitable.

Also, this could conflict with the work on #188

KingDarBoja · 2020-12-12T20:59:47Z

Awesome initiative and great job!

The Typescript build is failing on a few places, please take a look at them.

I resolved the ESLint config and also made the build pass by doing some casting because it is not clear some types for getNames and getName methods.

michaelwittig · 2020-12-16T09:52:54Z

this is super hard to review. Have you changed anything expect converting to TS? @danilofuchs suggests that you also fixed a bug here?

KingDarBoja · 2020-12-16T12:58:26Z

this is super hard to review. Have you changed anything expect converting to TS? @danilofuchs suggests that you also fixed a bug here?

As far as I know, only the linked issues which are about return types being inconsistent with d.ts (type definitions).

michaelwittig · 2020-12-16T13:12:31Z

So how is this thing going to be published? So far, all I do is npm publish. I don't think that that's enough now?

I don't have much time to invest in this project at the moment and I'm not involved in any frontend work at the moment. Therefore, I don't feel very confident in merging this before I know how to publish it.

KingDarBoja · 2020-12-16T13:25:22Z

Yeah, this is a work in progress as I forget to setup the build steps for compilation and enable multiple browser supports as well. After that, the npm publish can be called without issues but wanted to get feedback from other TypeScript users as well :)

michaelwittig · 2020-12-16T14:08:46Z

@KingDarBoja I see.

danilofuchs · 2020-12-16T15:48:19Z

When using Typescript (or any preprocessor like Babel), you have to execute a command to generate output .js files before running npm publish.

Usually, that would be npm run build

- remove old index.d.ts type - generate declarations

KingDarBoja · 2020-12-24T14:25:48Z

Rebased the branch to get latest changes and also added the build script with the default tsconfig.json options and some extra for emitting the d.ts types and load json modules as well. Would be great if someone install it after running the build script and play around to spot any issue regarding compatibility.

KingDarBoja · 2021-04-02T01:18:57Z

Almost done with the whole switching as I have installed it locally in some app (using verdaccio) and works almost perfectly, just need to manage the langs directory to be included in the public API to avoid importing it like:

import { getName, registerLocale } from 'i18n-iso-countries';
import { LocaleEN } from 'i18n-iso-countries/dist/langs/en';
registerLocale(LocaleEN);

And rather be like:

import { getName, registerLocale } from 'i18n-iso-countries';
import { LocaleEN } from 'i18n-iso-countries/langs/en';
registerLocale(LocaleEN);

danilofuchs · 2021-04-02T01:24:18Z

@KingDarBoja I'm not sure I liked the convertion of locale files from JSON to TS.
JSON is easier for beginners to use and many open PRs are made based on these files.

TS can still check JSON files with the resolveJsonModules tsconfig flag, using a cast localeEN as LocaleData

KingDarBoja · 2021-04-02T14:23:40Z

@KingDarBoja I'm not sure I liked the convertion of locale files from JSON to TS.
JSON is easier for beginners to use and many open PRs are made based on these files.

TS can still check JSON files with the resolveJsonModules tsconfig flag, using a cast localeEN as LocaleData

Does this flag let tree-shaking work with json files? My only issue is that I wasn't taking into account the lang files in the build step but since those are json files, I don't think tree-shaking applies for these.

If that's the case, that means converting JSON files to JS or something that can be tree-shakable with tools like Webpack or Rollup but never tried such ways as TS compiler can do the job with TS files.

KingDarBoja · 2021-04-02T16:59:20Z

@danilofuchs after trying out some stuff, I made it work as you expected while keeping the langs directory files as .json:

import { getName, registerLocale } from 'i18n-iso-countries';
import { COUNTRY_CODES } from 'i18n-iso-countries/codes';
import { localeEN } from 'i18n-iso-countries/bundled';

Kinda based on the #188 but without rollup, while relying on some workarounds due to TS lack of support for subpath exports from NodeJS v12+.

package.json

{
  "typings": "dist/index.d.ts",
  "main": "dist/entry-node.js",
  "browser": {
    "./dist/entry-node.js": "./dist/index.js"
  },
  "exports": {
    ".": {
      "import": "./dist/index.js"
    },
    "./codes": {
      "import": "./dist/codes.js"
    },
    "./bundled": {
      "import": "./dist/entry-node.js"
    }
  },
  "typesVersions": {
    "*": {
      "codes": ["dist/codes"],
      "bundled": ["dist/entry-node"]
    }
  },
}

Still have some errors on the consumer side but guess it is a progress. Looks like it is caused by webpack 4 (as I am testing it in a Angular 11 project):

Module not found: Error: Can't resolve 'i18n-iso-countries/bundled'
Module not found: Error: Can't resolve 'i18n-iso-countries/codes'

Update 1

At the end, decided to keep the TS conversion of those json files as it gave me some headaches trying to structure into the final bundle.

Also managed to make the langs imports to work as below in some Angular 11 app I used for playing around:

import { getName, registerLocale } from 'i18n-iso-countries';
import { LocaleEN } from 'i18n-iso-countries/langs';

@Component({ })
export class AppComponent {
  constructor() {
    registerLocale(LocaleEN);
    console.log(getName('co', 'en')); // Colombia
    console.log(getName('co', 'es')); // undefined
  }
}

Only downside is that I exported all locales in a barrel index.ts file, so tree-shaking those unused locales doesn't work as it can be seen at below report generated by source-map-explorer:

Update 2

After tweaking a bit the base tsconfig to change module option from commonjs to ES2015, now tree-shaking works for those projects using webpack 4 under the hood (Angular as example).

Converted dv and sw json files to TS files.

cwqt · 2021-06-24T12:51:11Z

Any more progress / work arounds for using a single locale?, especially with angular where it builds an entire app per locale, having every locale in the bundle is a bit of a bloat

KingDarBoja · 2021-06-27T19:41:36Z

Any more progress / work arounds for using a single locale?, especially with angular where it builds an entire app per locale, having every locale in the bundle is a bit of a bloat

While waiting for this PR, I am making a flag pack library that relies on this package but to enable tree-shaking of unused lang files, I have copied the source code into its own library (not released yet): https://github.com/KingDarBoja/ngx-nations

Probably gonna call it @nation/i18n as it is not angular specific whereas @nation/ngx-core will be ofc Angular support 👯‍♂️

Yberion · 2021-12-06T14:01:45Z

Any news regarding this PR?

bschnabel · 2023-03-14T13:40:57Z

any plans to merge this into master at some point?

michaelwittig · 2023-03-14T13:50:40Z

@bschnabel I don't think that the work here is done. More like a WIP. Correct me if I'm wrong @KingDarBoja ?

KingDarBoja · 2023-03-14T18:53:42Z

@bschnabel I don't think that the work here is done. More like a WIP. Correct me if I'm wrong @KingDarBoja ?

Almost 2 years have passed since last update so I can't remember if there was something missing. Probably not, maybe some conflict updates there and there but I am no longer interested in continuing with this PR (no free time for it).

Hope someone else completes this one if the TypeScript conversion is still wanted 😄

michaelwittig · 2023-03-14T18:59:25Z

@KingDarBoja I see. Let me close this PR.

danilofuchs reviewed Dec 12, 2020

View reviewed changes

.eslintrc Outdated Show resolved Hide resolved

.eslintrc Outdated Show resolved Hide resolved

.eslintrc Show resolved Hide resolved

KingDarBoja mentioned this pull request Dec 16, 2020

Incompatibility with IE11 #193

Open

KingDarBoja added 8 commits December 24, 2020 09:05

chore: switch to TypeScript

f48575d

refactor: use npm instead of yarn

641110a

- remove old index.d.ts type - generate declarations

docs: update docstrings at index file

348994e

refactor: simplify type checks at some functions

4fca45c

fix: cast some function arguments

cee9a52

chore: missing config at eslintrc file

a6c3316

tests: use ts-expect-error to keep old conditions

2b8245b

misc: sort codes

d24c6a5

KingDarBoja force-pushed the refactor/typescript-migration branch from 586821f to d24c6a5 Compare December 24, 2020 14:13

KingDarBoja added 2 commits December 24, 2020 09:19

chore: add build script

c0baf98

chore: add diacritics types as devDependency

ee00454

KingDarBoja added 2 commits April 1, 2021 19:24

Merge branch 'master' into refactor/typescript-migration

6529517

refactor: locales as TS files

34af058

chore: export langs submodule and allow tree-shaking

495aa16

KingDarBoja added 4 commits April 2, 2021 14:50

tests: revert small import change

b13e732

tests: set TS_NODE_PROJECT for mocha

0080628

refactor: export types and codes via barrel index

8abb4c9

Merge branch 'master' into refactor/typescript-migration

f5141cb

Converted dv and sw json files to TS files.

michaelwittig closed this Mar 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: switch to TypeScript #218

chore: switch to TypeScript #218

KingDarBoja commented Dec 12, 2020 •

edited

Loading

KingDarBoja commented Dec 12, 2020

danilofuchs left a comment

danilofuchs commented Dec 12, 2020

KingDarBoja commented Dec 12, 2020 •

edited

Loading

michaelwittig commented Dec 16, 2020

KingDarBoja commented Dec 16, 2020

michaelwittig commented Dec 16, 2020

KingDarBoja commented Dec 16, 2020

michaelwittig commented Dec 16, 2020

danilofuchs commented Dec 16, 2020

KingDarBoja commented Dec 24, 2020 •

edited

Loading

KingDarBoja commented Apr 2, 2021

danilofuchs commented Apr 2, 2021

KingDarBoja commented Apr 2, 2021 •

edited

Loading

KingDarBoja commented Apr 2, 2021 •

edited

Loading

cwqt commented Jun 24, 2021

KingDarBoja commented Jun 27, 2021

Yberion commented Dec 6, 2021 •

edited

Loading

bschnabel commented Mar 14, 2023

michaelwittig commented Mar 14, 2023

KingDarBoja commented Mar 14, 2023

michaelwittig commented Mar 14, 2023

chore: switch to TypeScript #218

chore: switch to TypeScript #218

Conversation

KingDarBoja commented Dec 12, 2020 • edited Loading

KingDarBoja commented Dec 12, 2020

danilofuchs left a comment

Choose a reason for hiding this comment

danilofuchs commented Dec 12, 2020

KingDarBoja commented Dec 12, 2020 • edited Loading

michaelwittig commented Dec 16, 2020

KingDarBoja commented Dec 16, 2020

michaelwittig commented Dec 16, 2020

KingDarBoja commented Dec 16, 2020

michaelwittig commented Dec 16, 2020

danilofuchs commented Dec 16, 2020

KingDarBoja commented Dec 24, 2020 • edited Loading

KingDarBoja commented Apr 2, 2021

danilofuchs commented Apr 2, 2021

KingDarBoja commented Apr 2, 2021 • edited Loading

KingDarBoja commented Apr 2, 2021 • edited Loading

Update 1

Update 2

cwqt commented Jun 24, 2021

KingDarBoja commented Jun 27, 2021

Yberion commented Dec 6, 2021 • edited Loading

bschnabel commented Mar 14, 2023

michaelwittig commented Mar 14, 2023

KingDarBoja commented Mar 14, 2023

michaelwittig commented Mar 14, 2023

KingDarBoja commented Dec 12, 2020 •

edited

Loading

KingDarBoja commented Dec 12, 2020 •

edited

Loading

KingDarBoja commented Dec 24, 2020 •

edited

Loading

KingDarBoja commented Apr 2, 2021 •

edited

Loading

KingDarBoja commented Apr 2, 2021 •

edited

Loading

Yberion commented Dec 6, 2021 •

edited

Loading