kinto.js icon indicating copy to clipboard operation
kinto.js copied to clipboard

rename kinto.js to a better name

Open glasserc opened this issue 9 years ago • 15 comments

A better name for kinto.js should reference the fact that it is offline-first, based on IndexedDB, and/or provides the notion of adapters.

kinto-offline seems misleading and kinto-offline-first seems too long.

Any other ideas?

glasserc avatar Jun 07 '16 16:06 glasserc

@DirtyF suggested kinto-sync.js which sounds rather nice.

n1k0 avatar Jun 07 '16 16:06 n1k0

What about kinto-local-sync.js

Natim avatar Jun 09 '16 15:06 Natim

kinto-browser.js? I like it kinda contains O'Brother

n1k0 avatar Jun 09 '16 16:06 n1k0

kinto-browser-sync ? (because kinto-http could also be used from inside a browser)

almet avatar Jun 17 '16 14:06 almet

Other great propositions from the meeting:

  • kinto-storage.js
  • kinto-offline.js
  • kinto-offlinefirst.js

Natim avatar Jul 05 '16 16:07 Natim

kinto-disconnected.js?

glasserc avatar Jul 05 '16 16:07 glasserc

Ooh! How about "kinto-unplugged.js"?

glasserc avatar Jul 05 '16 16:07 glasserc

Ooh! How about "kinto-unplugged.js"?

Now I really like this one :)

n1k0 avatar Jul 05 '16 17:07 n1k0

I love it as well :)

almet avatar Jul 05 '16 20:07 almet

https://twitter.com/pouchdb/status/754016070546051072?s=09

leplatrem avatar Jul 15 '16 21:07 leplatrem

@chartjes instinctively suggested kinto-sync.js, so I guess that it will be!

  • kinto-sync for the npm package
  • kinto-sync.js for the Github package

leplatrem avatar Sep 22 '16 23:09 leplatrem

@leplatrem sorry to revive an almost four-year-old conversation, but do you still want to do this? If so, I have some thoughts, but if not please feel free to close this issue :)

dstaley avatar May 09 '20 17:05 dstaley

Yes! Feel free to tackle this!

leplatrem avatar May 11 '20 17:05 leplatrem

kinto.js currently does two things:

  1. Store, query, and retrieve arbitrary data
  2. Sync that data with a remote server

While the first is the core feature of the library, the second is actually completely optional. You can use kinto.js without the sync feature, and thus without kinto-http.js. With that in mind, I propose that we name the library either kinto-db or kinto-storage. I'm kind of partial to kinto-db, since it allows us to grow the storage/querying features of the library without feeling boxed in by the name. I think either db or storage implies that the client is actually storing data, rather than simply retrieving it from a server. When we add new adapters, they can be named kinto-adapter-engine (so, for example, kinto-storage-sqlite).

It could look something like this:

import { DB } from "kinto-db";

const db = new DB();
const collection = db.collection("articles");
import { Storage } from "kinto-storage";
import { SqliteAdapter } from "kinto-adapter-sqlite";

const storage = new Storage({
  adapter: (name, options) => new SqliteAdapter(name, options),
});
const collection = storage.collection("articles");

I'm also considering moving all our JavaScript packages to an npm org, so the package names would look like:

  • @kinto/storage
  • @kinto/http
  • @kinto/adapter-sqlite

dstaley avatar May 13 '20 19:05 dstaley

I like kinto-db, as well as kinto-offline or kinto-storage :)

But I'm not sure about adapter in package names. This is more like a programming pattern notion than anything else. Suffixing the main name should be enough IMO (eg. kinto-db-sqlite, kinto-storage-websql, ...)

I'm also considering moving all our JavaScript packages to an npm org, so the package names would look like:

Good idea! Let's do that!

leplatrem avatar May 14 '20 09:05 leplatrem