alet 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2faa54a215c89f284e48ea7e7765ce94f649957db7975f0534ec7e785e27418d
-  data.tar.gz: '09ac5631b2bd809379dc48df00307d2fc5c10a813ed63ad9fb52ba82c630ba2b'
+  metadata.gz: 132887d88cce23c1ca1eef8d0d7da205f334d814259e22bfdb88481342050fba
+  data.tar.gz: 628305b1623058660782f647ddad310969844f9450cd5d3dc719927868931784
 SHA512:
-  metadata.gz: bba98f043bc20784a443fe43fadc48c821b617e2cbd4317df37057946fa857783a97aba2da6029a44c365f50484d7916394e5d2895b2207b21cc895b84af820a
-  data.tar.gz: fe1eec27d3e6231ad2973d1bdd79acaa90609ce95612616f1ae7ca299972977b0080237989f4d3ec0907df1eefba8f12c99adcccef4e3d684e9061d9cb231e88
+  metadata.gz: 8e1f2220dee8fa6982806f026b7080572e9807fa75a52a778cc5d8133f2a5a57d2760f8c4d1d5d92f234a717e4f7c6dfe419123664133cbdd255ecdf8faf65d4
+  data.tar.gz: 3cd1d82e9d7f81850ee4d53eb03243f6e51ecab3d63c7b9b2c28daa8b6c26e563a0b2cbdb997f592cb2696b4ab68e08520a08d90930a3b28397e30853e462781

data/lib/alet/app.rb

@@ -1,8 +1,8 @@
 require 'gli'
 require 'irb'
-require 'alet/config'
+require 'alet'
 require 'alet/utils/irb'
-require 'alet/generate/project'
+require 'alet/project'
 require 'alet/version'
 require 'i18n'
 
@@ -29,11 +29,9 @@ module Alet
     desc t('cli.target_org')
     flag [:o, 'target-org'], default_value: nil, arg_name: 'org'
 
-
     desc t('cli.irb.desc')
     command :irb do |c|
       c.desc desc t('cli.target_org')
-      c.flag [:o, 'target-org'], default_value: nil, arg_name: 'org'
 
       c.example "alet", desc: t('cli.irb.example.default')
       c.example "alet -o org", desc: t('cli.irb.example.target_org')
@@ -44,32 +42,39 @@ module Alet
       end
     end
 
-    desc t('cli.generate.desc')
-    command [:generate, :g] do |c|
-      c.desc desc t('cli.generate.project.desc')
-      c.arg_name 'project_name'
-      c.command :project do |prj|
-        prj.desc t('cli.generate.project.target_org')
-        prj.flag [:o, 'target-org'], default_value: nil, arg_name: 'org'
+    desc t('cli.project.desc')
+    command [:project, :p] do |prj|
+      prj.desc desc t('cli.project.generate.desc')
+      prj.arg_name 'project_name'
 
-        prj.desc t('cli.generate.project.manifest')
-        prj.switch [:m, :manifest], negatable: false
+      prj.desc t('cli.project.open_editor')
+      prj.switch [:e, 'editor-open'], negatable: false
 
-        prj.desc t('cli.generate.project.open_editor')
-        prj.switch [:e, 'editor-open'], negatable: false
+      prj.command [:generate, :g] do |gen|
+        gen.desc t('cli.project.generate.manifest')
+        gen.switch [:m, :manifest], negatable: false
 
-        prj.desc t('cli.generate.project.retrieve')
-        prj.switch [:r, 'retrieve'], negatable: false
+        gen.desc t('cli.project.generate.retrieve')
+        gen.switch [:r, 'retrieve'], negatable: false
 
-        prj.example "alet generate project MyProject", desc: t('cli.generate.project.example.default')
-        prj.example "alet generate project MyProject -m", desc: t('cli.generate.project.example.manifest')
-        prj.example "alet generate project MyProject -m -o org", desc: t('cli.generate.project.example.from_org')
-        prj.example "alet generate project MyProject -mr -o org", desc:t('cli.generate.project.example.retrieve')
+        gen.example "alet generate project MyProject", desc: t('cli.project.generate.example.default')
+        gen.example "alet generate project MyProject -m", desc: t('cli.project.generate.example.manifest')
+        gen.example "alet -o org generate project MyProject -m", desc: t('cli.project.generate.example.from_org')
+        gen.example "alet -o org generate project MyProject -mr", desc:t('cli.project.generate.example.retrieve')
 
-        prj.action do |_, options, args|
+        gen.action do |global_options, _options, args|
+          options = global_options.merge _options
           Alet::Project.generate(args.first, **options)
         end
       end
+
+      prj.desc desc t('cli.project.update.desc')
+      prj.command [:update, :u] do |update|
+        update.action do |global_options, _options, args|
+          options = global_options.merge _options
+          Alet::Project.update(args.first, **options)
+        end
+      end
     end
 
     default_command :irb

data/lib/alet/config/locales/en.yml

@@ -3,45 +3,52 @@ en:
     desc:            A Ruby-styled Salesforce console utility
     target_org:      Username or alias of the target org
     irb:
-      desc:          start irb session(if there is no subcommand specified, irb gets default)
+      desc:          Start irb session(if there is no subcommand specified, irb gets default)
       example:
-        default:     start irb session
-        target_org:  start irb session with specifying target org
-    generate:
-      desc:          generate resources that are related to Salesforce DX project
-      project:
-        desc:        generate salesforce DX project
+        default:     Start irb session
+        target_org:  Start irb session with specifying target org
+    project:
+      desc:          Create/Update a Salesforce DX project
+      open_editor:   Open editor(vs code) to edit the project
+      generate:
+        desc:        Generate a salesforce DX project
         target_org:  Username or alias of the target org, which the manifest and source files are generated based on
         manifest:    Generate a manifest (package.xml)
         retrieve:    Retrieve source files from org
-        open_editor: open editor(vs code) to edit the project
         example:
           default:   create a Salesfore DX project
           manifest:  create a Salesfore DX project with manifest file (package.xml)
           from_org:  The manifest file is built based on org
           retrieve:  The manifest file and medadata source files are built based on org. This option is only available with -o option.
-  connection:
-    description: Current connection with Salesforce
+      update:
+        desc:        Update a salesforce DX project based on current org
   apex:
     description: Execute Apex code
-  gen:
-    description: Generate sObject classes
+  model:
+    description: List/Generate sObject classes
+    list:
+      noclass: No class is generated in this session
+      title:   【Generated Classes】
     help: |
       ## Name
-      gen
+      model
 
       ## SYNOPSIS
-      gene sObjectType...
+      model [list|load sObjectType...]
 
       ## DESCRIPTION
-      generate sObject classes
+      1. show sobject model classes that has been generated already.
+      2. generate classes that represent sobjects.
 
       ## ARGUMENTS
-      **sObjectType** sObject type
+      **list** list model classes that has been generated already.
+      **load sObjectType...** generate sObject classes
 
       ## EXAMPLES
       ```shell
-      gen Account Contact User
+      model  # shows sobject model classes that has been generated already.
+      model list # same as above
+      model load Account Contact User # load Account, Contact and User sobject classes
   query:
     description: Query by SOQL
     help: |
@@ -76,7 +83,8 @@ en:
       ## ARGUMENTS
       **command** - shell command
 
-      If no command is specified, it starts interactive mode. To escape interactive mode, press CTRL-D
+      If no command is specified, it starts interactive mode.
+      To escape interactive mode, press CTRL-D (CTR-Z for Windows)
 
       ## EXAMPLE
       ```shell
@@ -101,3 +109,241 @@ en:
       ```shell
       export SELECT Id, Name FROM Account
       ```
+  org:
+    description: Current connection with Salesforce
+    help: |
+      ## NAME
+      org
+
+      ## SYNOPSIS
+      org
+
+      ## DESCRIPTION
+      show current connection settings
+  grep:
+    description: find sObject
+    help: |
+      ## NAME
+      grep
+
+      ## SYNOPSIS
+      grep [-ln] regexp
+
+      ## DESCRIPTION
+      find sobject by name or label 
+
+      ## ARGUMENTS
+      **regexp** regular expression that indicates name or label
+
+      ## OPTIONS
+      **-l, [---label]** find by only label
+      **-n, [---api-name]** find by only api name
+
+      ## EXAMPLE
+      ```shell
+      grep Account
+      grep -n Account*
+      ```
+  desc:
+    description: show object summary
+    table:
+      field: Fields
+      relation: Relations
+      record_type: RecordType
+    column:
+      label: label
+      name:  name
+      type:  type
+      relation_name:  relation name
+      relation_type:  relation type
+      relation_class:  class name
+      relation_field:  field name
+      record_type_name: name
+      record_type_id:   id
+      record_type_developer_name: developer name
+    relation_type:
+      parent: child-parent
+      child: parent-child
+    error:
+      notfound: Not Found
+    help: |
+      ## NAME
+      desc
+
+      ## SYNOPSIS
+      desc [-rta] object-name
+
+      ## DESCRIPTION
+      show an object summary
+
+      ## ARGUMENTS
+      **object-name** object name
+
+      ## OPTIONS
+      **-r, [---relation]** show relationships
+      **-t, [---record-type]** show record types
+      **-a, [---all])** show all summary
+
+      if there is no options only field summary is shown.
+
+      ## EXAMPLE
+      ```shell
+      desc Account    # show Account's field summary
+      desc -r Account # show Account's relationships
+      ```
+  conn:
+    description: connection settings
+    invalid_subcommand: invalid subcommand
+    help: |
+      ## NAME
+      conn
+
+      ## SYNOPSIS
+      conn [reset]
+
+      ## DESCRIPTION
+      Show current connection settings when no subcommand is specified. Or reset the connection when "reset" subcommand is executed.
+  gen:
+    description: generate Salesforce DX project resources
+    error:
+      no_subcommand: subcommand isn't specified
+      invalid_subcommand: invalid subcommand
+      file_duplicated: the same component already exists
+    help: |
+      ## NAME
+      gen
+
+      ## SYNOPSIS
+      `gen sub-command ...`
+
+      ## DESCRIPTION
+      generate resources in your local Salesforce DX project
+
+      ## ARGUMENTS
+      you must specify a subcommand and its arguments.
+      **apex**  generate an Apex class or Apex trigger in local project
+      **lwc**   generate an lwc in local project
+
+      ### apex subcommand:
+
+      #### SYNOPSIS
+      `gen apex [-t|-e event1,event2,...|-o object-name] name`
+
+      #### DESCRIPTION
+      generate an Apex class or Apex trigger in local project.
+
+      #### ARGUMENTS
+      `name` the name of the Apex class or Apex trigger
+
+      #### OPTIONS
+      `-t`, `--trigger` generate a trigger
+      `-o`, `--sobject` sobject that the trigger works
+      `-e`, `--event` events that the trigger works.Available values are: bi, ai, bu, au, bd, ad and aud.If there are multiple values they must join with camma like "bi,bu" (no space).
+
+      ##### available values of event
+
+      |value|meaning|
+      |bi|before insert|
+      |ai|after insert|
+      |bu|before update|
+      |au|after update|
+      |bd|before delete|
+      |ad|after delete|
+      |aud|after undelete|
+
+      ## EXAMPLE
+      ```shell
+      gen apex MyClass1
+      gen apex MyTrigger --trigger
+      gen apex -t MyTrigger -o Account
+      gen apex -t MyTrigger -o Account --event bi,au # generate trigger named MyTrigger that works when before insert and after update on Account object
+      ```
+
+      ### lwc subcommand
+
+      #### SYNOPSIS
+      `gen lwc [-l label|-d description|-e|-t target1,target2,...|-o object1,object2,...] name`
+
+      #### DESCRIPTION
+      generate LWC(Lightning Web Component) files in local project.
+
+      #### ARGUMENTS
+      `name` component name of LWC
+
+      #### OPTIONS
+      `-l`, `--label` specify `masterLabel` section in the xml configulation file.
+      `-d`, `--description` specify `description` section in the xml configulation file.
+      `-e`, `--exposed` specify `isExposed` section in the xml configulation file. Default is false
+      `-t`, `--target` specify `target` section in the xml configulation file.If there are multiple values they must join with camma.
+      `-o`, `--object` specify `object` section in the xml configulation file. this options is only available when `target` includes **record**.If there are multiple values they must join with camma.
+
+      ##### available values of target
+
+      |value |meaning                |
+      |app   |lightning__AppPage     |
+      |flow  |lightning__FlowScreen  |
+      |home  |lightning__HomePage    |
+      |action|lightning__RecordAction|
+      |record|lightning__RecordPage  |
+      |tab   |lightning__Tab         |
+      |bar   |lightning__UtilityBar  |
+
+      #### EXAMPLE
+      ```shell
+      gen lwc LWC1
+      gen lwc LWC1 -l "my first LWC"
+      gen lwc LWC1 -d "this is my first LWC"
+      gen lwc LWC1 -t app,home,record
+      gen lwc LWC1 -o Account -t record
+      ```
+
+      #### SEE ALSO
+      [XML Configuration File Elements](https://developer.salesforce.com/docs/platform/lwc/guide/reference-configuration-tags.html)
+  deploy:
+    description: deploy project's resources
+    error:
+      no_arguments: no arguments
+    help: |
+      ## NAME
+      deploy
+
+      ## SYNOPSIS
+      `deploy [-d|-t test1,test2...|-l test-level] component-type component-name...`
+
+      ## DESCRIPTION
+      deploy(upload) local project's files to the Salesforce org
+
+      ## ARGUMENTS
+      `component-type` `file` or metadata type name. for metadata type, some shortcut names are available.
+      `component-name` name of the component. if `component-type` is `file` this must be a file path or directory path. If `component-type` is metadata type the name can include wildcard(*)
+
+      ### shortcut name of metadata type
+
+      |shortcut name|metadata type|
+      |apex|ApexClass|
+      |trigger|ApexTrigger|
+      |lwc|LightningComponentBundle|
+
+      you can check all metadata types by sf command (`sf org list metadata-type`)
+
+      ## OPTIONS
+      `-d`, `--dryrun`　Validate deploy and run Apex tests but don’t save to the org.
+      `-l`, `--test-level` deployment Apex testing level
+      `-t`, `--tests` Apex tests to run when --test-level is RunSpecifiedTests. when multiple tests are specified, join them with comma (no space).
+      `-m`, `--manifest` deploy files according to manifest file. When this options is specified `component-name` is ignored.
+
+      ### available test-level value
+
+      |value|meaning|
+      |RunSpecifiedTests|Runs only the tests that you specify with the --tests flag|
+      |RunLocalTests|All tests in your org are run, except the ones that originate from installed managed and unlocked packages|
+      |RunLocalTests|All tests in your org are run, including tests of managed packages.|
+
+      ## EXAMPLE
+      ```shell
+      deploy apex MyClass1
+      deploy lwc myLWC
+      deploy apex MyClass --test-level RunSpecifiedTests --tests test1,test2
+      deploy file -m manifest/package.xml
+      deploy file force-app/main/default/class/MyClass1.cls
+      ```