@chain-registry/cli 1.30.5 → 1.30.6

package/README.md

@@ -89,7 +89,7 @@ Options:
 - `--outputDir`: Directory to output the generated TypeScript files.
 - `--registryDir`: Path to the chain registry directory.
 - `--strictTypeSafety`: Enables strict TypeScript type definitions.
-- `--useCamelCase`: Converts JSON schema properties to camelCase in the generated TypeScript files.
+- `--camelCase`: Converts JSON schema properties to camelCase in the generated TypeScript files.
 
 ## Related
 

package/commands/codegen/index.js

@@ -3,8 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.commands = void 0;
 const workflows_1 = require("@chain-registry/workflows");
 const fs_1 = require("fs");
+const utils_1 = require("../../utils");
 const commands = async (argv, prompter, _options) => {
-    const { registryDir, outputDir, strictTypeSafety, useCamelCase } = await prompter.prompt(argv, [
+    const { registryDir, outputDir, strictTypeSafety, camelCase } = await prompter.prompt(argv, [
         {
             type: 'text',
             name: 'registryDir',
@@ -23,7 +24,7 @@ const commands = async (argv, prompter, _options) => {
         },
         {
             type: 'confirm',
-            name: 'useCamelCase',
+            name: 'camelCase',
             default: true,
             useDefault: false
         }
@@ -38,7 +39,8 @@ const commands = async (argv, prompter, _options) => {
         registry,
         schemaTSOptions: {
             strictTypeSafety,
-            useCamelCase
+            camelCase,
+            camelCaseFn: utils_1.toCamelCase
         }
     });
     generator.generateTypes();

package/commands/index.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.commands = void 0;
+const help_1 = require("../help");
 const codegen_1 = require("./codegen");
 const info_1 = require("./info");
 const validate_1 = require("./validate");
-const help_1 = require("../help");
 const commands = async (argv, prompter, _options) => {
     let command;
     if (argv._.length > 0) {

package/dist/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Dan Lynch <pyramation@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/README.md

@@ -0,0 +1,115 @@
+# @chain-registry/cli
+
+<p align="center" width="100%">
+    <img height="90" src="https://user-images.githubusercontent.com/545047/190171475-b416f99e-2831-4786-9ba3-a7ff4d95b0d3.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/cosmology-tech/chain-registry/actions/workflows/run-tests.yml">
+    <img height="20" src="https://github.com/cosmology-tech/chain-registry/actions/workflows/run-tests.yml/badge.svg" />
+  </a>
+   <a href="https://github.com/cosmology-tech/chain-registry/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
+   <a href="https://www.npmjs.com/package/@chain-registry/cli"><img height="20" src="https://img.shields.io/github/package-json/v/cosmology-tech/chain-registry?filename=workflows%2Fcli%2Fpackage.json"></a>
+</p>
+
+The `@chain-registry/cli` is a powerful command-line interface designed to interact with the Chain Registry, allowing users to fetch information, validate data, and generate TypeScript interfaces directly from JSON schemas.
+
+## Features
+
+🔍 **Info**: Retrieve detailed information about chains, assets, and asset lists.
+
+✅ **Validate**: Check the integrity and validity of the registry data against its schemas.
+
+🛠️ **Codegen**: Generate TypeScript definitions for use in development, ensuring type safety and adherence to the schema definitions.
+
+## Installation
+
+To get started with `@chain-registry/cli`, install it via npm or yarn:
+
+```js
+npm install @chain-registry/cli
+# or
+yarn add @chain-registry/cli
+```
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Command Details](#command-details)
+  - [Info](#info)
+  - [Validate](#validate)
+  - [Codegen](#codegen)
+- [Related Projects](#related)
+- [Credits](#credits)
+- [Disclaimer](#disclaimer)
+
+## Command Details
+
+### Info
+
+Fetch and display information about entities in the chain registry:
+
+```sh
+chain-registry info
+```
+
+Options:
+
+- `chain`: Fetch information specific to a chain.
+- `asset-list`: Fetch asset lists associated with a specific chain.
+- `asset`: Fetch detailed information about a specific asset.
+- `--registryDir`: Path to the chain registry directory.
+
+### Validate
+
+Validate the data in the registry against the provided JSON schemas:
+
+```sh
+chain-registry validate
+```
+
+Options:
+
+- `--registryDir`: Path to the chain registry directory (required).
+- `--useStrict`: Enables strict mode in the schema validation process, ensuring that only explicitly permitted properties are present in the data (default: false).
+- `--allErrors`: Configures the validator to return all errors found during validation instead of stopping at the first error (default: true).
+- `--useDefaults`: Applies default values defined in the schema during validation, filling in missing data as needed (default: true).
+
+### Codegen
+
+Generate TypeScript interfaces for the registry:
+
+```sh
+chain-registry codegen --outputDir ./src --registryDir /path/to/registry
+```
+
+Options:
+
+- `--outputDir`: Directory to output the generated TypeScript files.
+- `--registryDir`: Path to the chain registry directory.
+- `--strictTypeSafety`: Enables strict TypeScript type definitions.
+- `--camelCase`: Converts JSON schema properties to camelCase in the generated TypeScript files.
+
+## Related
+
+Checkout these related projects:
+
+* [@cosmology/telescope](https://github.com/cosmology-tech/telescope) Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
+* [@cosmwasm/ts-codegen](https://github.com/CosmWasm/ts-codegen) Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.
+* [chain-registry](https://github.com/cosmology-tech/chain-registry) Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
+* [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit) Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
+* [create-cosmos-app](https://github.com/cosmology-tech/create-cosmos-app) Set up a modern Cosmos app by running one command.
+* [interchain-ui](https://github.com/cosmology-tech/interchain-ui) The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
+* [starship](https://github.com/cosmology-tech/starship) Unified Testing and Development for the Interchain.
+
+## Credits
+
+🛠 Built by Cosmology — if you like our tools, please consider delegating to [our validator ⚛️](https://cosmology.zone/validator)
+
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

package/dist/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@chain-registry/cli",
+  "version": "1.30.6",
+  "description": "Chain Registry CLI",
+  "author": "Dan Lynch <pyramation@gmail.com>",
+  "homepage": "https://github.com/cosmology-tech/chain-registry",
+  "license": "SEE LICENSE IN LICENSE",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "bin": {
+    "registry": "cli.js",
+    "chain-registry": "cli.js"
+  },
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cosmology-tech/chain-registry"
+  },
+  "bugs": {
+    "url": "https://github.com/cosmology-tech/chain-registry/issues"
+  },
+  "scripts": {
+    "copy": "copyfiles -f LICENSE README.md package.json dist",
+    "clean": "del dist/**",
+    "prepare": "npm run build",
+    "build": "npm run clean; tsc; tsc -p tsconfig.esm.json; npm run copy",
+    "dev": "ts-node src/cli",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@chain-registry/interfaces": "^0.29.5",
+    "@chain-registry/workflows": "^1.30.5",
+    "chalk": "^4.1.0",
+    "deepmerge": "^4.3.1",
+    "inquirerer": "1.8.0",
+    "minimist": "^1.2.8"
+  },
+  "keywords": [
+    "cli",
+    "chain-registry",
+    "web3",
+    "cosmos",
+    "interchain"
+  ]
+}

package/esm/commands/codegen/index.js

@@ -1,7 +1,8 @@
 import { Registry, SchemaTypeGenerator } from '@chain-registry/workflows';
 import { existsSync } from 'fs';
+import { toCamelCase } from '../../utils';
 export const commands = async (argv, prompter, _options) => {
-    const { registryDir, outputDir, strictTypeSafety, useCamelCase } = await prompter.prompt(argv, [
+    const { registryDir, outputDir, strictTypeSafety, camelCase } = await prompter.prompt(argv, [
         {
             type: 'text',
             name: 'registryDir',
@@ -20,7 +21,7 @@ export const commands = async (argv, prompter, _options) => {
         },
         {
             type: 'confirm',
-            name: 'useCamelCase',
+            name: 'camelCase',
             default: true,
             useDefault: false
         }
@@ -35,7 +36,8 @@ export const commands = async (argv, prompter, _options) => {
         registry,
         schemaTSOptions: {
             strictTypeSafety,
-            useCamelCase
+            camelCase,
+            camelCaseFn: toCamelCase
         }
     });
     generator.generateTypes();

package/esm/commands/index.js

@@ -1,7 +1,7 @@
+import { getUsage } from '../help';
 import { commands as codegen } from './codegen';
 import { commands as info } from './info';
 import { commands as validate } from './validate';
-import { getUsage } from '../help';
 export const commands = async (argv, prompter, _options) => {
     let command;
     if (argv._.length > 0) {

package/esm/help.js

@@ -38,7 +38,7 @@ ${header('COMMANDS')}
             ${normal('Specifies the path to the chain registry directory.')}
         ${option('--strictTypeSafety')}
             ${normal('Enables strict TypeScript type definitions.')}
-        ${option('--useCamelCase')}
+        ${option('--camelCase')}
             ${normal('Converts JSON schema properties to camelCase in the generated TypeScript files.')}
 
 ${header('EXAMPLES')}

package/esm/utils.js

@@ -10,3 +10,13 @@ export function getVersion() {
     const pkg = readAndParsePackageJson();
     return pkg.version;
 }
+// MARKED AS NOT DRY
+export function toCamelCase(key) {
+    return key
+        // First, remove all leading non-alphabet characters except $
+        .replace(/^[^a-zA-Z$]+/, '')
+        // Convert what follows a separator into upper case
+        .replace(/[-_\s]+(.)?/g, (_, c) => c ? c.toUpperCase() : '')
+        // Ensure the first character of the result is always lowercase
+        .replace(/^./, (c) => c.toLowerCase());
+}

package/help.js

@@ -44,7 +44,7 @@ ${header('COMMANDS')}
             ${normal('Specifies the path to the chain registry directory.')}
         ${option('--strictTypeSafety')}
             ${normal('Enables strict TypeScript type definitions.')}
-        ${option('--useCamelCase')}
+        ${option('--camelCase')}
             ${normal('Converts JSON schema properties to camelCase in the generated TypeScript files.')}
 
 ${header('EXAMPLES')}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chain-registry/cli",
-  "version": "1.30.5",
+  "version": "1.30.6",
   "description": "Chain Registry CLI",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "homepage": "https://github.com/cosmology-tech/chain-registry",
@@ -46,9 +46,5 @@
     "web3",
     "cosmos",
     "interchain"
-  ],
-  "devDependencies": {
-    "strfy-js": "^2.2.2"
-  },
-  "gitHead": "63df544ec7e864f893bdc7a4605a1666ca292da3"
+  ]
 }

package/utils.d.ts

@@ -1,2 +1,3 @@
 export declare function displayVersion(): void;
 export declare function getVersion(): string;
+export declare function toCamelCase(key: string): string;

package/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVersion = exports.displayVersion = void 0;
+exports.toCamelCase = exports.getVersion = exports.displayVersion = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const package_1 = require("./package");
 // Function to display the version information
@@ -18,3 +18,14 @@ function getVersion() {
     return pkg.version;
 }
 exports.getVersion = getVersion;
+// MARKED AS NOT DRY
+function toCamelCase(key) {
+    return key
+        // First, remove all leading non-alphabet characters except $
+        .replace(/^[^a-zA-Z$]+/, '')
+        // Convert what follows a separator into upper case
+        .replace(/[-_\s]+(.)?/g, (_, c) => c ? c.toUpperCase() : '')
+        // Ensure the first character of the result is always lowercase
+        .replace(/^./, (c) => c.toLowerCase());
+}
+exports.toCamelCase = toCamelCase;