Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Generate documentation #180

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 140 additions & 1 deletion packages/typo3-fractor/docs/typo3-fractor-rules.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 14 Rules Overview
# 24 Rules Overview

## AbstractMessageGetSeverityFluidFractor

Expand Down Expand Up @@ -303,6 +303,85 @@ Migrates option cols to size for TCA type none

<br>

## RemoveConfigDisablePageExternalUrlFractor

Remove config.disablePageExternalUrl

- class: [`a9f\Typo3Fractor\TYPO3v12\TypoScript\RemoveConfigDisablePageExternalUrlFractor`](../rules/TYPO3v12/TypoScript/RemoveConfigDisablePageExternalUrlFractor.php)

```diff
-config.disablePageExternalUrl = 1
+-
```

<br>

## RemoveConfigDoctypeSwitchFractor

Remove config.doctypeSwitch

- class: [`a9f\Typo3Fractor\TYPO3v12\TypoScript\RemoveConfigDoctypeSwitchFractor`](../rules/TYPO3v12/TypoScript/RemoveConfigDoctypeSwitchFractor.php)

```diff
-config.doctypeSwitch = 1
+-
```

<br>

## RemoveConfigMetaCharsetFractor

Remove config.metaCharset

- class: [`a9f\Typo3Fractor\TYPO3v12\TypoScript\RemoveConfigMetaCharsetFractor`](../rules/TYPO3v12/TypoScript/RemoveConfigMetaCharsetFractor.php)

```diff
-config.metaCharset = 1
+-
```

<br>

## RemoveConfigSendCacheHeadersOnlyWhenLoginDeniedInBranchFractor

Remove config.sendCacheHeaders_onlyWhenLoginDeniedInBranch

- class: [`a9f\Typo3Fractor\TYPO3v12\TypoScript\RemoveConfigSendCacheHeadersOnlyWhenLoginDeniedInBranchFractor`](../rules/TYPO3v12/TypoScript/RemoveConfigSendCacheHeadersOnlyWhenLoginDeniedInBranchFractor.php)

```diff
-config.sendCacheHeaders_onlyWhenLoginDeniedInBranch = 1
+-
```

<br>

## RemoveConfigSpamProtectEmailAddressesAsciiOptionFractor

Remove config.spamProtectEmailAddresses with option ascii

- class: [`a9f\Typo3Fractor\TYPO3v12\TypoScript\RemoveConfigSpamProtectEmailAddressesAsciiOptionFractor`](../rules/TYPO3v12/TypoScript/RemoveConfigSpamProtectEmailAddressesAsciiOptionFractor.php)

```diff
-config.spamProtectEmailAddresses = ascii
+-
```

<br>

## RemoveNewContentElementWizardOptionsFractor

Remove TSConfig mod.web_layout.disableNewContentElementWizard and mod.newContentElementWizard.override

- class: [`a9f\Typo3Fractor\TYPO3v12\TypoScript\RemoveNewContentElementWizardOptionsFractor`](../rules/TYPO3v12/TypoScript/RemoveNewContentElementWizardOptionsFractor.php)

```diff
-mod.web_layout.disableNewContentElementWizard = 1
-mod.newContentElementWizard.override = 1
+-
```

<br>

## RemoveNoCacheHashAndUseCacheHashAttributeFluidFractor

Remove noCacheHash="1" and useCacheHash="1" attribute
Expand Down Expand Up @@ -367,6 +446,53 @@ Remove useCacheHash TypoScript setting

<br>

## RemoveWorkspaceModeOptionsFractor

Remove TSConfig options.workspaces.swapMode and options.workspaces.changeStageMode

- class: [`a9f\Typo3Fractor\TYPO3v12\TypoScript\RemoveWorkspaceModeOptionsFractor`](../rules/TYPO3v12/TypoScript/RemoveWorkspaceModeOptionsFractor.php)

```diff
-options.workspaces.swapMode = any
-options.workspaces.changeStageMode = any
+-
```

<br>

## RenameConfigXhtmlDoctypeToDoctypeFractor

Migrate typoscript xhtmlDoctype to doctype

- class: [`a9f\Typo3Fractor\TYPO3v12\TypoScript\RenameConfigXhtmlDoctypeToDoctypeFractor`](../rules/TYPO3v12/TypoScript/RenameConfigXhtmlDoctypeToDoctypeFractor.php)

```diff
-config.xhtmlDoctype = 1
+config.doctype = 1
```

<br>

## RenameTcemainLinkHandlerMailKeyFractor

Rename key mail to email for MailLinkHandler

- class: [`a9f\Typo3Fractor\TYPO3v12\TypoScript\RenameTcemainLinkHandlerMailKeyFractor`](../rules/TYPO3v12/TypoScript/RenameTcemainLinkHandlerMailKeyFractor.php)

```diff
TCEMAIN.linkHandler {
- mail {
+ email {
handler = TYPO3\\CMS\\Recordlist\\LinkHandler\\MailLinkHandler
label = LLL:EXT:recordlist/Resources/Private/Language/locallang_browse_links.xlf:email
displayAfter = page,file,folder,url
scanBefore = url
}
}
```

<br>

## TranslationFileYamlFractor

Use key translationFiles instead of translationFile
Expand All @@ -390,3 +516,16 @@ Use key translationFiles instead of translationFile
```

<br>

## UseConfigArrayForTSFEPropertiesFractor

Use config array in TSFE instead of deprecated class properties

- class: [`a9f\Typo3Fractor\TYPO3v12\TypoScript\UseConfigArrayForTSFEPropertiesFractor`](../rules/TYPO3v12/TypoScript/UseConfigArrayForTSFEPropertiesFractor.php)

```diff
-page.10.data = TSFE:fileTarget
+page.10.data = TSFE:config|config|fileTarget
```

<br>
Loading