ts_schema 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d6e690832a89b7cbde62be4a27e6dc9374be937df6627bff391db15c2f1e777
-  data.tar.gz: 9a6aec0dd27e0938cdd856ad723dc28898a582de67122b7ed9bc147ed6d335c6
+  metadata.gz: e970a98bd2aea544c74c48dac67799e5b713ef56ab8eaa023662f2901973983a
+  data.tar.gz: f259f07ed9fd61a06bf8b0c777df0a50696472534ba48f43737351a8982b3fb5
 SHA512:
-  metadata.gz: 7df830e6e1a3543944f9550e57801f16c9ef2121462983c67944814e70f21c47f48b8fe6d5841286c92d1876cee50c8b32bf1533a49ae90f436234ed52723bcd
-  data.tar.gz: 1cc1c840bef030c08afee4480102d6a4cbda128d30c1de01969ad9b03312c9f71f3019c589ea382e23756ba267f0ab939bc839f62c79619381d7535e9be33de7
+  metadata.gz: 30fcd65e0da2df3d5741fe12ed25f84139d3d94b1bc840661a9404105fe5a15e5a0f7a328817283c23592de13ab196d1d31df4398281c6a186d3afcef0d23eb4
+  data.tar.gz: 1a44cc70e7acfb79209f03d2311eb368c1d128832c4e8f586c5ca7f7fa209d5f80641fd8ee57848f6e7b7f9573b1c97e399d372fcb8407b772dd4096b5d1be57

data/README.md

@@ -26,6 +26,48 @@ You can manually generate the schema file by running:
 rails ts_schema:generate
 ```
 
+### Default type mappings
+
+|Ruby Type|Typescript Type|
+|:---|:---|
+|string|string|
+|text|string|
+|integer|number|
+|enum|number|
+|bigint|number|
+|float|number|
+|decimal|number|
+|json|Record<string, any>|
+|jsonb|Record<string, any>|
+|binary|string|
+|boolean|boolean|
+|date|string|
+|datetime|string|
+|timestamp|string|
+|datetime_with_timezone|string|
+|inet|string|
+|cidr|string|
+|macaddr|string|
+
+### Initializer options
+
+|Option|Default|Values|Description|
+|---|---|---|---|
+|case              |`:camel`|`:camel`<br/>`:snake`<br/>`:pascal`|camelCase<br/>snake_case<br/>PascalCase|
+|output            |`Rails.root.join('app', 'assets', 'javascripts', 'schema.d.ts')`|Any path|Path to output generated file|
+|auto_generate     |`true`|`boolean`|Whether to automatically (re)generate the defenitions after running migrations|
+|custom_types      |`{}`|`{ ruby_type: 'typescriptType' }`|Use to add or override type mappings for any type|
+|default_type      |`:string`|Any typescript type|The default output type to use if a ruby type is not included in the type mappings|
+|include_associated|`true`|`boolean`|Whether to include associated models as fields on the generated interfaces|
+|parent_classes    |`["ApplicationRecord"]`|Array of string names of top level classes|Any class names included in this array will be querried for subclasses to generate types for|
+|additional_models |`[]`|Array of string names of ActiveRecord models|Add model names which don't inherit from classes included in `parent_classes`, but which should have types generated|
+|field_overrides   |`{ encrypted_password: :password,  password: :optional, }`|Hash of field names with the following values:<br/> `:optional`: Makes it an optional field by adding '?' to the defintion (example: password?: string)<br/>`:omit`: Omits the field from being output in the schema entirely<br/>`[string]`: Field name override. Will replace any instance of the hash key with the value. The default values replace `password` with `encrypted_password`|Overwrite, omit, or make optional any field name. Applies to all generated classes|
+|namespace         |`:schema`|string\|symbol|The typescript namespace to contain generated types|
+|schema_type       |`:interface`|`:interface`\|`:type`|Whether to generate typescript definitions as types or interfaces. Interfaces are recommended since they are easier to extend|
+|indent|`:tab`|`:tab`\|`:space`|Indentation using tabs or spaces|
+|spaces|`2`|number|Number of spaces for indentation if indentation is set to spaces|
+
+
 ## Gotchas
 
 Sometimes ActiveRecord's inflections will alter the class name. For instance, with a class named `Five`; `"Fives".singularize` returns "Fife", which is not the classname. In the case where Rails alters the classname for an association, you must explicitly define it on the association in the model using `class_name`. Example: `has_many :fives, class_name: "Five"`.

data/lib/generators/templates/ts_schema.rb

@@ -1,26 +1,5 @@
-# Default type mappings:
-#
-# string:                 string
-# text:                   string
-# integer:                number
-# enum:                   number
-# bigint:                 number
-# float:                  number
-# decimal:                number
-# json:                   Record<string, any>
-# jsonb:                  Record<string, any>
-# binary:                 string
-# boolean:                boolean
-# date:                   string
-# datetime:               string
-# timestamp:              string
-# datetime_with_timezone: string
-# inet:                   string
-# cidr:                   string
-# macaddr:                string
-
 TsSchema.setup do |config|
-  # Case options: camel|snake|pascal
+  # Case options for field names: camel|snake|pascal
   #
   # config.case = :camel
 
@@ -35,7 +14,27 @@ TsSchema.setup do |config|
   # config.auto_generate = true
 
 
-  # Add custom type mappings or overrides
+  # Add custom type mappings or overrides (as strings or symbols)
+  #
+  # Default type mappings:
+  #   string:                 string
+  #   text:                   string
+  #   integer:                number
+  #   enum:                   number
+  #   bigint:                 number
+  #   float:                  number
+  #   decimal:                number
+  #   json:                   Record<string, any>
+  #   jsonb:                  Record<string, any>
+  #   binary:                 string
+  #   boolean:                boolean
+  #   date:                   string
+  #   datetime:               string
+  #   timestamp:              string
+  #   datetime_with_timezone: string
+  #   inet:                   string
+  #   cidr:                   string
+  #   macaddr:                string
   #
   # config.custom_types = {
   #   
@@ -70,9 +69,10 @@ TsSchema.setup do |config|
 
   # Ignore certain fields, omitting them from the generated schema: :optional|(string)|false
   # Key is the name of the field to override options for.
+  #
   # [:optional] will make this an optional field by adding '?' to the defintion (example: password?: string)
   # [(string)]  enter a field name override, for instance rename encrypted_password to password
-  #   In that scenario, also specifying passwoord as an optional field will append a ? in the output
+  #             In that scenario, also specifying password as an optional field will append a ? to password
   # [:omit]     will omit the field from being output in the schema entirely
   #
   # config.field_overrides: {

data/lib/ts_schema/schema_generator.rb

@@ -19,6 +19,8 @@ module TsSchema
           m.to_s.constantize
         end)
       end
+      @models.sort_by! { |c| c.name }
+
       @types = @config.types.stringify_keys.merge(@config.custom_types.stringify_keys || {})
     end
 
@@ -34,7 +36,7 @@ module TsSchema
 
     def generate
       type_template = ""
-			
+
       @models.each do |model|
         columns = map_column_types(model)
         columns.concat(map_associations(model)) if @config.include_associated

data/lib/ts_schema/version.rb

@@ -1,3 +1,3 @@
 module TsSchema
-  VERSION = "0.1.13"
+  VERSION = "0.1.14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ts_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Avram Walden
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2022-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,7 +63,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/aviemet
   source_code_uri: https://github.com/aviemet/ts_schema
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.32
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Generates typescript definitions from ActiveRecord
 test_files: []