Annotated package.json for idb-keyval#

1
{
2
  // Name and version are required if you want to publish to npm
3
  "name": "idb-keyval",
4
  "version": "6.1.0",
5

6
  // Description is listed by npm search and used on websites
7
  "description": "A super-simple-small keyval store built on top of IndexedDB",
8

9
  // The “primary entry point” to your program - if the user installs the package and
10
  // runs require("package-name") the exports object from this module will be returned
11
  "main": "./dist/compat.cjs",

1
  "module": "./dist/compat.js",
2

3
  // The unpkg CDN says “If you omit the file path (i.e. use a “bare” URL), unpkg will
4
  // serve the file specified by the unpkg field in package.json, or fall back to main.”
5
  // - this should be what happens when you hit https://unpkg.com/idb-keyval - but I
6
  // tried that just now and got an error saying “Cannot find "/dist/iife-compat.js"
7
  // in idb-keyval@6.1.0” so something isn’t quite working right here.
8
  //
9
  // The iife-compat.js filename here suggests that this file will use the Immediately
10
  // invoked function expression pattern, which looks like this:
11
  //
12
  // ​​(function () { /* ... */ })();
13
  //
14
  // It’s a pattern to avoid polluting the global namespace with variables and functions.
15
  "unpkg": "./dist/iife-compat.js",
16

17
  // This is a Node.js extension. The Node docs say: “The "exports" field provides an
18
  // alternative to "main" where the package main entry point can be defined while also
19
  // encapsulating the package, preventing any other entry points besides those defined
20
  // in "exports". This encapsulation allows module authors to define a public interface
21
  // for their package.”
22
  "exports": {
23
    // I don’t yet understand why this is a nested object
24
    ".": {
25
      "module": "./dist/index.js",
26
      "import": "./dist/index.js",
27
      "default": "./dist/index.cjs"
28
    },
29
    "./dist/*": "./dist/*",
30
    "./package.json": "./package.json"
31
  },
32

33
  // These files are included when the package is installed as a dependency
34
  "files": [
35
    "dist/**"
36
  ],
37

38
  // Another node.js extension: https://nodejs.org/api/packages.html#type says: Files
39
  // ending with .js are loaded as ES modules when the nearest parent package.json file
40
  // contains a top-level field "type" with a value of "module".
41
  "type": "module",
42

43
  // TypeScript extension indicating the location of type information for this module
44
  "types": "./dist/index.d.ts",
45

46
  // The webpack Tree Shaking docs say “The new webpack 4 release expands on this capability
47
  // with a way to provide hints to the compiler via the "sideEffects" package.json property
48
  // to denote which files in your project are "pure" and therefore safe to prune if unused”
49
  "sideEffects": false,
50

51
  // Running “npm run build” or “npm run dev” or “npm run prepack” runs these:
52
  "scripts": {
53
    "build": "rollup -c && node lib/size-report.js",
54
    "dev": "rollup -cw & serve",
55
    "prepack": "npm run build"
56
  },
57

58
  // A bunch more metadata used when the package is shown on npm
59
  "repository": {
60
    "type": "git",
61
    "url": "git+https://github.com/jakearchibald/idb-keyval.git"
62
  },
63
  "keywords": [
64
    "idb",
65
    "indexeddb",
66
    "store",
67
    "keyval",
68
    "localstorage",
69
    "storage",
70
    "promise"
71
  ],
72
  "author": "Jake Archibald",
73
  "license": "Apache-2.0",
74
  "bugs": {
75
    "url": "https://github.com/jakearchibald/idb-keyval/issues"
76
  },
77
  "homepage": "https://github.com/jakearchibald/idb-keyval#readme",
78

79
  // These are the dependencies that get installed when you run “npm install” from the
80
  // root of the package - but they are not installed when an end-user uses
81
  // “npm install name-of-package”
82
  "devDependencies": {
83
    "@babel/core": "^7.16.0",
84
    "@babel/plugin-external-helpers": "^7.16.0",
85
    "@babel/plugin-transform-runtime": "^7.16.4",
86
    "@babel/preset-env": "^7.16.4",
87
    "@babel/runtime": "^7.16.3",
88
    "@rollup/plugin-babel": "^5.3.0",
89
    "@rollup/plugin-commonjs": "^21.0.1",
90
    "@rollup/plugin-node-resolve": "^13.0.6",
91
    "@types/chai": "^4.2.22",
92
    "@types/mocha": "^9.0.0",
93
    "chai": "^4.3.4",
94
    "conditional-type-checks": "^1.0.5",
95
    "del": "^6.0.0",
96
    "filesize": "^8.0.6",
97
    "glob": "^7.2.0",
98
    "husky": "^7.0.4",
99
    "lint-staged": "^12.1.2",
100
    "mocha": "^9.1.3",
101
    "prettier": "^2.5.0",
102
    "rollup": "^2.60.2",
103
    "rollup-plugin-terser": "^7.0.2",
104
    "serve": "^13.0.2",
105
    "typescript": "^4.3.5"
106
  },
107

108
  // Husky is a tool for managing git pre-commit hooks
109
  "husky": {
110
    "hooks": {
111
      "pre-commit": "lint-staged"
112
    }
113
  },
114

115
  // lint-staged runs linters against staged files - here it is called by Husky
116
  "lint-staged": {
117
    "*.{js,css,md,ts,html}": "prettier --write"
118
  },
119

120
  // This package has only one non-dev dependency
121
  "dependencies": {
122
    // safari-14-idb-fix provides a idbReady().then(() => … function for waiting
123
    // until IDB is ready to be accessed in Safari, as a workaround for a bug that
124
    // existed prior to Safari 14.7
125
    "safari-14-idb-fix": "^3.0.0"
126
  }
127
}