Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 4.03 KB

README.md

File metadata and controls

80 lines (57 loc) · 4.03 KB
Raw

AEM-STUDIO

An AEM VS CODE snippet extension for frontend development. Learn more about VS Code snippets

Features

  • Quickly generate/scaffold AEM snippets
  • Work in progress (WIP)

Snippets usage/triggers

  • aem_dialog a dialog settings into _cq_dialog/.content.xml file
  • aem_dialog_field inserts a dialog field into _cq_dialog/.content.xml into the items node
  • aem_htmlTag insert a dialog field into the _cq_htmlTags/.content.xml file
  • aem_component insert component into your /.component.xml file
  • aem_component_advanced insert component with sling:resourceSuperType field into your /.component.xml file
  • mvn_archetype Generates the code/commands for generating an AEM Maven archetype project in batch mode command(s)

AEM PROJECT ARCHETYPE (usage)

Generates the code/commands for generating an AEM Maven archetype project in batch mode command(s) Info and instructions -- https://github.com/adobe/aem-project-archetype USAGE (running AEM author server is required for steps last 4 steps)

  • Copy everything below the DEMO line
  • Open your terminal (git bash preferred on windows), cd into your install folder, and paste the copied lines your terminal hit enter
  • You should see a output with success message (below) when completed
Creating content skeleton...
[INFO] Project created from Archetype in dir: C:\Users\SSANDY\source\AEM\blank-demo
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  14.093 s
[INFO] Finished at: 2020-09-23T15:41:11-04:00
[INFO] ------------------------------------------------------------------------
  • CD into the folder blueprints generated from the package
  • Please make sure you have a running instance of AEM Author (localhost:4502)
  • Paste the following mvn -PautoInstallSinglePackage clean install into your terminal and hit enter
  • You should see a BUILD SUCCESS MESSAGE(S)
  • For additional options visit https://github.com/adobe/aem-project-archetype

Development

  • Clone this repo
  • Install Microsoft VSCE npm install -g vsce exension manager
  • Install Auto Changelog npm install -g auto-changelog Auto Changelog
  • Install np npm install --global np np
  • Build extension npm run build
  • npm run history to generate changelogs

Contributing

If you would like to contribute to this extension

  • Clone the repo git clone https://github.com/shawn-sandy/aem-fe-studio
  • Add an extension to the package.json fix a bug/typo etc
  • Add snippets to snippets.code-snippets file
  • Submit a Pull request
  • Approval subject to review

Issues

I you find any errors, bugs, typos, would like to recommend an extension, etc. Please open an issue here https://github.com/shawn-sandy/codestudio/issues

License

The MIT License (MIT)

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.

Enjoy!