Git Product home page Git Product logo

db_rector's Introduction

TYPO3 Extension "DB Rector"

Disclaimer

It is recommended to NOT run this extension in productive environments!

Installation

This extension must be installed via composer, e.g. composer req -dev creifenscheid/db-rector, to install typo3-rector and get it running. You can download it from the TYPO3 Extension Repository, but it still has to be installed via composer.

What does it do

This extension is an adapter to run typo3-rector in the TYPO3 backend to refactor typoscript stored in sys_template.config.

Features

  • backend module to
    • view all typoscript stored in the db
    • run typo3-rector on single db entries
    • Review the result of the typo3-rector process (incl. diff view)
    • apply typo3-rector result to the corresponding sys_template record
    • roll back the original typoscript
  • security
    • backend module is only active in TYPO3 context „development“ by default

Note

If the sys_template record has been adjusted after the rector process or the applying of the rector result, the corresponding rector model is going to be reset.
So the updated sys_template typoscript can be processed again.

Known working setups

  • DDEV (TYPO3 11, TYPO3 12)

Known not working setups

  • MacOS + MAMP

Configuration

Extension configuration

Parameter Default Optional Description
ignoreTYPO3Context false yes If set to true, the context of the TYPO3 installation is going to be ignored - this is not recommended

Rector configuration

To configure typo3-rector a file named rector.php is required.
This file is generated more or less automatically.
There is some sort of „template“, which is copied into the working folder.

Since just typoscript refactoring is needed, the rector config file is kept small and simple.

The following configuration parameter are defined dynamically:

Parameter Value(s) Description
phpVersion The php version of the TYPO3 installation target version to support
sets 2 defined "UP_TO_TYPO3" sets
  • the previous TYPO3 version
  • the current TYPO3 version
Rule sets to run on the target code

Support

I don't want your money or anything else. I am doing this for fun, with heart and to improve my coding skills. Constructive critisism is very welcome. If you want to contribute, feel free to do so. Thank you!

db_rector's People

Contributors

creifenscheid avatar

Watchers

 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.