ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Api​Gen

by dans98 ST3

ApiGen support for Sublime Text 3.

Details

Installs

  • Total 861
  • Win 554
  • Mac 162
  • Linux 145
Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16
Windows 1 1 1 0 1 0 0 0 0 0 0 1 0 1 0 1 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 0 1
Mac 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

ApiGen support for Sublime Text 3

Features

Currently The plugin allows click to run functunallity. Simply right click on any open file, or any filename in the sidebar to access the ApiGen options.

Options

  • Generate - Takes the clicked on file, and uses its path as a starting point to walk back to the filesystem root. The plugin checks each directory along the way for an apigen.neon file. It will halt it's walk if it finds a file, and call ApiGen passing the apigen.neon file path as the (–config) option.
  • Generate Freeform - Works the same as the Generate option, but the user is prompted to provide additonal command line arguments.
  • Selfupdate - Runs the ApiGen (selfupdate) option, to update the apigen.phar file to the latest revision.
  • Version - Runs the ApiGen (-v) version option.
  • Freeform - The user is presented with a prompt, and allowed to pass any arguments to ApiGen they wish.

Instalation

Requirements

  • You must meet the requirements of, and have ApiGen instilled on your machine.

Steps

  1. Install the plugin using Package Control
    1. From the main menu of Sublime Text go to Preferences
    2. Choose Package Control
    3. Choose Install Package
    4. Type ApiGen
  2. Configure the plugin
    1. From the main menu of Sublime Text go to Preferences
    2. Choose Package Settings
    3. Choose ApiGen
    4. Choose Settings - User
    5. Set the setting to the approrite value for your machine.
      • phpBin - The location of the php executable on your machine.
      • pharPath - The location of apigen on your machine.
      • configFileName - The name of the config file to search for. The default is apigen.neon.
      • additionalGenerateArgs - Additional command line arguments, to be appended to the end of the Generate command.

Author

Sublime ApiGen was created & is maintained by Daniel Sherman.

License

Sublime ApiGen is open source software licensed under the BSD 3-Clause license.