npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@liuli-util/i18next-dts-gen

v0.6.4

Published

> [中文](https://github.com/rxliuli/liuli-tools/blob/master/libs/i18next-dts-gen/README.ZH_CN.md)

Downloads

29

Readme

@liuli-util/i18next-dts-gen

中文

Introduction

i18next's typescript type definition generator can generate type definitions from multiple language translation json files, supporting nested objects and parameters.

Use

The type definition generation of the international configuration of cli itself is also done by cli (bootstrapping)

i18next-dts-gen --dirs src/i18n # Scan this directory for json files and generate index.d.ts type definitions

Detail

$ i18next-dts-gen -h
Usage: bin [options]

Generate .d.ts type definitions from json

Options:
  -i, --dirs <dirs...>  Directory containing one or more translation files
  -w, --watch             Whether to use watch mode
  -h, --help              display help for command

Skills

Prompt

prompt

Navigation

navigation

Search and replace

searchAndReplace

Motivation

Why should I write this when there are already many third-party type definition generators, and even the latest version of i18next has an official typescript solution?

In short, they are not perfect.

Let's start with the official i18next solution, which replaces json files with ts files, but does not support parameters and nested objects.

Note: The latest version seems to take advantage of typescript 4.2's recursive types and template string types for type safety, but this doesn't actually work very well. Also only react-i18next is available.

Then i18next-typescript, a third-party library, almost meets my needs, except for one thing: support for object parameters. There is also something like Jack Chicory's i18n-codegen, which is very elegant in code design, but again, does not support ecologies other than react.

Also, as far as I'm concerned, I think it's easier and more reasonable to use generators to generate simple types than to support such features from the type system.

Design

schema

flowchart

FAQ

Are all features of i18next supported?

No, only a subset of i18next is supported here.

  • [x] Generate type definitions for multiple localized json profiles
  • [x] Include parameters are supported
    • [ ] Object parameters are not supported
  • [ ] Does not support nested keys - we think that using. Segmentation is sufficient, and it is easier to find and replace globally
  • [ ] does not support configuration namespaces, nested split strings, and we consider conventions over configuration
  • [ ] Configuration files other than json are not supported, we believe json files are more friendly to non-developers and easier for developers to handle when needed
  • [ ] i18next namespaces are not supported, i.e. translation file splitting