danielvaijk / breakpoint Goto Github PK

• Process/store type declarations and exports.
• Take in "types" in package.json as additional content entries source.

• Check that previously published files are not missing in the package.
• Check that the entry module in main is included in the package.
• Check that the entry modules in exports are included in the package.
• Check that the entry module in browser is included in the package.
• Check that the bin scripts defined in bin are included in the package.

The rationale is that since breakpoint is not a library (or, at least, does not offer one), we don't care about providing convenience as part of a public API for error handling different error types. As an application, what matters is how effortlessly we're able to handle runtime errors.

• Allow extensionless files, since those are supported by npm.
• Fix matching for tarball files against entry values that are prefixed with absolute or relative path components.

• Exports
• Browser

• Array
• Date
• Object literals
• class instances?
• ...?

Reuse contents as "cache" if already in .tmp directory. Verify integrity with content hash?

• Check for $schema property and use that as a spec.
• If there is no $schema, compare previous and current properties 1:1.
• The $schema URL should be versioned, otherwise the spec can change on the fly.

• For a tarball, all its contents = package contents.
• For a local package, it's all the glob patterns defined in files (+ npm ignore lists).

Validate if it's a relative path (i.e., not a Node.js module).

Make sure to parse any .npmrc configuration files that set a custom registry=.

• Dynamic import
• Invoking functions inside the module body

See here https://nodejs.org/api/packages.html#package-entry-points

Similar to JSON, we'll want to parse a schema and compare previous and current for any breaking changes.

Example:

import defaultExport, * as namedExports from './module';
export const example = {
  default: defaultExport,
  ...namedExports
};

We'll need:

1. A reference to every import specifier.
2. Find any exported values that contain any known import specifiers (also take into account that the value can be passed around to multiple variables/functions/etc before being re-exported).

• String
• Number
• BigInt
• Boolean
• undefined
• null

Basically, all primitive types except Symbol.