@atproto/lex 0.0.0

package/bin/lex

@@ -0,0 +1,165 @@
+#!/usr/bin/env node
+
+/* eslint-env node */
+/* eslint-disable @typescript-eslint/no-var-requires */
+
+// This file is referenced by the "bin" field in package.json. Because of that,
+// we need this file to exist on disk even before the project is built, so it is
+// written in plain JS. This allows package managers to properly link the CLI
+// command when the monorepo is being setup (during initial "pnpm install").
+
+const yargs = require('yargs')
+const { hideBin } = require('yargs/helpers')
+const { build } = require('@atproto/lex-builder')
+const { install } = require('@atproto/lex-installer')
+
+yargs(hideBin(process.argv))
+  .strict()
+  .command(
+    ['build', 'b'],
+    'Generate TypeScript lexicon schema files from JSON lexicon definitions',
+    (yargs) => {
+      return yargs.strict().options({
+        lexicons: {
+          array: true,
+          type: 'string',
+          demandOption: true,
+          default: './lexicons',
+          describe: 'directory containing lexicon JSON files',
+        },
+        out: {
+          type: 'string',
+          demandOption: true,
+          default: './src/lexicons',
+          describe: 'output directory for generated TS files',
+        },
+        clear: {
+          type: 'boolean',
+          default: false,
+          describe: 'clear output directory before generating files',
+        },
+        override: {
+          type: 'boolean',
+          default: false,
+          describe: 'override existing files (has no effect with --clear)',
+        },
+        pretty: {
+          type: 'boolean',
+          default: true,
+          describe: 'run prettier on generated files',
+        },
+        'ignore-errors': {
+          type: 'boolean',
+          default: false,
+          describe: 'how to handle errors when processing input files',
+        },
+        'pure-annotations': {
+          type: 'boolean',
+          default: false,
+          describe:
+            'adds `/*#__PURE__*/` annotations for tree-shaking tools. Set this to true if you are using generated lexicons in a library.',
+        },
+        exclude: {
+          array: true,
+          type: 'string',
+          describe:
+            'list of strings or regex patterns to exclude lexicon documents by their IDs',
+        },
+        include: {
+          array: true,
+          type: 'string',
+          describe:
+            'list of strings or regex patterns to include lexicon documents by their IDs',
+        },
+        lib: {
+          type: 'string',
+          default: '@atproto/lex',
+          describe:
+            'package name of the library to import the lex schema utility "l" from',
+        },
+        allowLegacyBlobs: {
+          type: 'boolean',
+          default: false,
+          describe:
+            'allow generating schemas that accept legacy blob references (disabled by default; enabling this might cause compatibility issues with records created a long time ago)',
+        },
+      })
+    },
+    async (argv) => {
+      await build(argv)
+    },
+  )
+  .command(
+    ['install [nsid..]', 'i [nsid..]'],
+    'Fetch and install lexicon documents',
+    (yargs) => {
+      return yargs.strict().options({
+        manifest: {
+          type: 'string',
+          default: './lexicons.json',
+          describe: 'path to lexicons.json manifest file',
+        },
+        save: {
+          alias: 's',
+          type: 'boolean',
+          default: true,
+          describe:
+            'Updates lexicons.json with installed lexicons (use --no-save to disable)',
+        },
+        build: {
+          type: 'boolean',
+          default: true,
+          describe:
+            'automatically build TypeScript lexicon schema files after installation (use --no-build to disable)',
+        },
+        update: {
+          type: 'boolean',
+          default: false,
+          describe:
+            'update all installed lexicons to their latest versions by re-resolving and re-installing them',
+        },
+        ci: {
+          type: 'boolean',
+          default: false,
+          describe:
+            'error if the installed lexicons do not match the CIDs in the lexicons.json manifest',
+        },
+        lexicons: {
+          array: true,
+          type: 'string',
+          demandOption: true,
+          default: './lexicons',
+          describe: 'directory containing lexicon JSON files',
+        },
+        out: {
+          type: 'string',
+          demandOption: true,
+          default: './src/lexicons',
+          describe: 'output directory for generated TS files',
+        },
+      })
+    },
+    async (argv) => {
+      await install({
+        add: argv.nsid,
+        save: argv.save,
+        ci: argv.ci,
+        update: argv.update,
+        lexicons: argv.lexicons,
+        manifest: argv.manifest,
+      })
+
+      if (argv.build) {
+        await build({
+          lexicons: argv.lexicons,
+          out: argv.out,
+          clear: true,
+          pretty: true,
+          pureAnnotations: true,
+          ignoreErrors: false,
+          lib: '@atproto/lex',
+        })
+      }
+    },
+  )
+  .parseAsync()

package/index.d.ts

@@ -0,0 +1,6 @@
+export { Client, buildAgent } from '@atproto/lex-client'
+export { l } from '@atproto/lex-schema'
+
+// Type only re-exports
+export type * from '@atproto/lex-client'
+export type * from '@atproto/lex-schema'

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@atproto/lex",
+  "version": "0.0.0",
+  "license": "MIT",
+  "description": "Lexicon tooling for AT",
+  "keywords": [
+    "atproto",
+    "lexicon",
+    "lex"
+  ],
+  "homepage": "https://atproto.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bluesky-social/atproto",
+    "directory": "packages/lex/lex"
+  },
+  "files": [
+    "./index.js",
+    "./index.d.ts",
+    "./bin"
+  ],
+  "bin": {
+    "ts-lex": "./bin/lex",
+    "lex": "./bin/lex"
+  },
+  "sideEffects": false,
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "browser": "./index.mjs",
+      "import": "./index.mjs",
+      "require": "./index.cjs",
+      "types": "./index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@atproto/lex-builder": "workspace:*",
+    "@atproto/lex-client": "workspace:*",
+    "@atproto/lex-installer": "workspace:*",
+    "@atproto/lex-schema": "workspace:*",
+    "yargs": "^17.0.0"
+  },
+  "devDependencies": {
+    "@types/yargs": "^17.0.33",
+    "jest": "^28.1.2"
+  },
+  "scripts": {
+    "build": "./bin/lex build --clear --lexicons ./lexicons --out ./tests/lexicons -- ignore additional npm args",
+    "test": "jest"
+  }
+}