Add README.md, CONTRIBUTING.md and export builders

Author: szuend

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# How to contribute
+
+We'd love to accept your patches and contributions to this project.
+
+## Before you begin
+
+### Sign our Contributor License Agreement
+
+Contributions to this project must be accompanied by a
+[Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
+You (or your employer) retain the copyright to your contribution; this simply
+gives us permission to use and redistribute your contributions as part of the
+project.
+
+If you or your current employer have already signed the Google CLA (even if it
+was for a different project), you probably don't need to do it again.
+
+Visit <https://cla.developers.google.com/> to see your current agreements or to
+sign a new one.
+
+### Review our community guidelines
+
+This project follows
+[Google's Open Source Community Guidelines](https://opensource.google/conduct/).
+
+## Contribution process
+
+### Code reviews
+
+All submissions, including submissions by project members, require review. We
+use GitHub pull requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+information on using pull requests.

README.md

@@ -0,0 +1,56 @@
+# source-map-scopes-codec
+
+This library hosts a production ready implementation of the source map ["Scopes" proposal](https://github.com/tc39/ecma426/blob/main/proposals/scopes.md).
+
+The library contains:
+  * Type definitions for structured scope information
+  * Encode and decode functions that can encode structured scope information into an already existing source map, or decode the structured scope information from a source map.
+  * A builder that helps with building the structured scope information.
+
+This library doesn't implement mappings encoding/decoding, but it does support encoding the scopes information into an already existing source map with "mappings" and "names".
+
+## Installation
+
+TODO: Fill in once this package is published on JSR (and maybe NPM).
+
+## Usage
+
+Using the library is straight-forward:
+
+```js
+import { encode } from "@chrome-devtools/source-map-scopes-codec";
+
+const scopeInformation = ...;
+const map = encode(scopeInformation);
+
+// Or with a pre-existing source map.
+const map = encode(scopeInformation, preExistingSourceMap);
+```
+
+To decode:
+
+```js
+import { decode } from "@chrome-devtools/source-map-scopes-codec";
+
+const scopeInformation = decode(sourceMap);
+```
+
+The library also contains a builder that makes creating structured scope information easier:
+
+```js
+import { ScopeInfoBuilder } from "@chrome-devtools/source-map-scopes-codec";
+
+const scopeInformation = new ScopeInfoBuilder()
+    .addScope(0, 0, { kind: "Global" })
+        .addScope(5, 10)
+        .setScopeKind("Function")      // Same as passing 'kind' to 'addScope'.
+        .setScopeName("foo")           // Same as passing 'name' to 'addScope'.
+        .endScope(10, 5)
+    .endScope(11, 1)
+    .addRange(0, 0, { scope: 0 })
+        .addRange(0, 10)
+        .setRangeScopeDefinition(1)    // Same as passing 'scope' to 'addRange'.
+        .endRange(0, 15)
+    .endRange(1, 1)
+    .build();
+```

deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@chrome-devtools/source-map-scopes-codec",
-  "version": "1.0.0",
+  "version": "0.1.0",
   "exports": "./mod.ts",
   "license": "BSD-3-Clause"
 }

mod.ts

@@ -14,3 +14,6 @@ export type {
 
 export { encode } from "./src/encode/encode.ts";
 export { decode } from "./src/decode/decode.ts";
+
+export { ScopeInfoBuilder } from "./src/builder/builder.ts";
+export { SafeScopeInfoBuilder } from "./src/builder/safe_builder.ts";

src/builder/safe_builder.test.ts

@@ -4,7 +4,7 @@
 
 import { beforeEach, describe, it } from "jsr:@std/testing/bdd";
 import { SafeScopeInfoBuilder } from "./safe_builder.ts";
-import { assert, assertThrows } from "jsr:@std/assert";
+import { assertThrows } from "jsr:@std/assert";
 
 describe("SafeScopeInfoBuilder", () => {
   let builder: SafeScopeInfoBuilder;