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

@emilioforrer/adonis-translatable

v1.0.1

Published

AdonisJS Lucid internationalization models

Downloads

4

Readme

Adonis Translatable

AdonisJS Lucid internationalization models.

Installation

npm

npm install @emilioforrer/adonis-translatable

yarn

yarn add @emilioforrer/adonis-translatable

Add the provider to your start/app.js file:

const providers = [
   // ...
   "@emilioforrer/providers/TranslatableProvider",
   // ...
 ];

How it works

Basically this addon creates a new relationship called translations to main model and delegates it's translatable attributes to the translation model.

So in order to work, you need to create a new model translations for your main model, add a trait and configure it.

How to use

Let's say we have a model App/Models/Role and want to translate the name and description attributes, in order to do that follow the next steps.

  1. Let's create the translation table for the model App/Models/Role.
schema.createTable('roles_translations', (table) => {
  table.increments()
  table.timestamps()
  /*
   * Translation fields
   */
  table.string('name').nullable()
  table.text('description').nullable()
  table.integer('role_id').unsigned()
  table.string('language_code')
})
  1. Now let's create the translation model App/Models/RoleTranslation
const Model = app.use('Model')
class RoleTranslation extends Model {
  static get table () {
    return 'roles_translations'
  }
}
  1. Next, we need to add a trait to the main model (App/Models/Role) and configure the options
const Model = app.use('Model')
class Role extends Model {
  static boot () {
    super.boot()
    this.addTrait('Translatable', {
      className: 'App/Models/RoleTranslation',
      attributes: ['name', 'description']
    })
  }
}

Translatable trait options

  • className: The name of the translation model. Defaults to: ''.
  • primaryKey: This is the primary key that will be used to create the translation relationship. Defaults to: Model.primaryKey.
  • foreignKey: This is the foreign key that will be used to create the translation relationship. Defaults to: ${singlularized_table_name}_id.
  • attributes: The list of attributes that we wish to be delegated to the translation model.

Development

Great! If you are planning to contribute to the framework, make sure to adhere to following conventions, since a consistent code-base is always joy to work with.

Run the following command to see list of available npm scripts.

npm

npm run

yarn

yarn run

Tests & Linting

  1. Lint your code using standardJs. Run yarn run lint command to check if there are any linting errors.
  2. Make sure you write tests for all the changes/bug fixes.
  3. Run yarn run test to lint and run your tests.