npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ast-to-entity-definitions

v3.0.3

Published

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/HiromiShikata/ast-to-entity-definitions/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/HiromiShikata/ast-to-entity-definitions/tree/main) [![code style: prettier](https:/

Downloads

192

Readme

ast-to-entity-definitions 🚀

CircleCI code style: prettier semantic-release: angular

Welcome to ast-to-entity-definitions! 🎉 This tool lets you easily generate EntityDefinition and EntityPropertyDefinition from your TypeScript type information. By doing this, you can streamline the process of source code generation!

📚 Table of Contents

Getting Started 🚀

You can start using ast-to-entity-definitions by installing it via npm:

npm install ast-to-entity-definitions

Or if you prefer Yarn:

yarn add ast-to-entity-definitions

Usage 🛠️

CLI

You can use the CLI to generate the EntityDefinition and EntityPropertyDefinition like so:

npx ast-to-entity-definitions ./src/domain/entities

Function

Alternatively, you can import the getEntityDefinitions function and use it in your own scripts:

import { getEntityDefinitions } from 'ast-to-entity-definitions/bin/adapter/entry-points/function/index';
console.log(getEntityDefinitions(path));

Examples 🔍

This example shows you the output of running ast-to-entity-definitions against a TypeScript file. This is a JSON representation of the EntityDefinition and EntityPropertyDefinition for each type:

import { execSync } from 'child_process';

describe('commander program', () => {
  it('should output file contents', () => {
    const output = execSync(
      'npx ts-node ./src/adapter/entry-points/cli/index.ts ./testdata/src/domain/entities',
    ).toString();

    console.log(output.trim());
  });
});

This example creates EntityDefinitions for a Administrator, Group, Item, User, UserAddress, and UserGroup types.

Contributing 🔨⌨️

Contributions, issues and feature requests are welcome! Feel free to check issues page.

License 📜

ast-to-entity-definitions is MIT licensed.


Give a ⭐️ if this project helped you!