Giter VIP home page Giter VIP logo

make's Introduction

Make - A TYPO3 extension to kickstart extensions and components

This TYPO3 extension allows to easily kickstart new TYPO3 extensions and components, such as Middlewares, Commands or Event listeners, by using an intuitive CLI approach.

TYPO3 Explained offers an extended tutorial on how to Kickstart a TYPO3 Extension with Make.

Installation

Install this extension as "dev" dependency via composer req b13/make --dev.

You can also download the extension from the TYPO3 Extension Repository and activate it in the Extension Manager of your TYPO3 installation.

Note: This extension is compatible with TYPO3 v10, v11 and v12 and should only be used in development context. So please make sure it is excluded for production releases.

Usage

All components, including new extensions, can be created with a dedicated command, executed on CLI with the typo3 binary: bin/typo3 make:<component_name>.

Example for creating a new extension:

bin/typo3 make:extension

All commands are interactive, which means you have to configure the extension or component by answering the displayed questions. Most of them automatically suggest a best practice default value, e.g. for identifiers or namespaces, which can just be confirmed.

It's also possible to customize those default values using environment variables with the B13_MAKE_ prefix. The full list is shown below:

  • B13_MAKE_BACKEND_CONTROLLER_DIR - Default directory for backend controllers
  • B13_MAKE_BACKEND_CONTROLLER_PREFIX - Default prefix for the backend controllers' route identifier
  • B13_MAKE_COMMAND_DIR - Default directory for commands
  • B13_MAKE_COMMAND_NAME_PREFIX - Default prefix for commands
  • B13_MAKE_EVENT_LISTENER_DIR - Default directory for event listeners
  • B13_MAKE_EVENT_LISTENER_IDENTIFIER_PREFIX - Default identifier prefix for event listeners
  • B13_MAKE_EXTENSION_DIR - Default directory for extensions
  • B13_MAKE_MIDDLEWARE_DIR - Default directory for middlewares
  • B13_MAKE_MIDDLEWARE_IDENTIFIER_PREFIX - Default identifier prefix for middlewares
  • B13_MAKE_MIDDLEWARE_TYPE - Default context type for middlewares

All component related commands require an extension name, for which the component should be created. This can also be set as first argument or globally with the B13_MAKE_EXTENSION_KEY environment variable.

Commands

Following commands are available

  • make:backendcontroller - Create a new backend controller
  • make:command - Create a new command
  • make:eventlistener - Create a new event listener
  • make:extension - Create a new extension
  • make:middleware - Create a new middleware

Credits

This extension was created by Oliver Bartsch in 2021 for b13 GmbH, Stuttgart.

Find more TYPO3 extensions we have developed that help us deliver value in client projects. As part of the way we work, we focus on testing and best practices ensuring long-term performance, reliability, and results in all our code.

make's People

Contributors

alexander-nitsche avatar bmack avatar davidsteeb avatar linawolf avatar lolli42 avatar o-ba avatar ochorocho avatar simonschaufi avatar susannemoog avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.