Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bolzer/ts-const-enum
A php cli tool to transform annotated php constants to typescript constants and enums
https://github.com/bolzer/ts-const-enum
constant constants enum enums php8 transformer typescript
Last synced: 12 days ago
JSON representation
A php cli tool to transform annotated php constants to typescript constants and enums
- Host: GitHub
- URL: https://github.com/bolzer/ts-const-enum
- Owner: BolZer
- License: apache-2.0
- Created: 2021-07-27T21:36:43.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-07-28T22:06:24.000Z (over 3 years ago)
- Last Synced: 2024-11-05T02:42:42.278Z (about 2 months ago)
- Topics: constant, constants, enum, enums, php8, transformer, typescript
- Language: PHP
- Homepage:
- Size: 55.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Ts-Const-Enum (PHP)
## Description
This tool will transform PHP Scalar-Constants - which are annotated with the provided attributes - to Typescript Constants and generates Typescript
Enums from annotated PHP one dimensional constant arrays. This may be useful if you want to reference a value in a condition within your Typescript Code. You can easily import the generated constants. This has
many advantages over just stating the value. If the value of the constant changes, your code won't break easily.
If you change the name of a php constant the typescript code won't compile unless you changed all occurrences of the old
constant name.
This is especially useful if you use alot of JS/TS-Frameworks and do conditionally rendering in regards to
values / properties. The Constants are by default prefixed with the declaring class followed by __ and the
constant name. You may provide an alias on attribute-level. Keep in mind to have unique names / alias as the
constants will land in one file.
### Usecase
#### Before
```Typescript
if (reflection.type === 16) {
// Do something when true
}
```
### After
```Typescript
import {TARGET_CLASS_CONSTANT} from "./constants";
if (reflection.type === TARGET_CLASS_CONSTANT) {
// Do something when true
}
```
# Installation
1. Require the dependency
```shell
composer require bolzer/ts-const-enum
```
2. Create in your root (where the vendor folder is) dir a config file
```shell
touch .ts-const-enum-config.php
```
3. Add the following content to the previously created file with the output path.
```php
setOutputPath(__DIR__ . '/generated/constants.ts')
;
```
4. Take a look at the config class for more config option.
5. Annotate some constants and arrays in your php code with the provided attributes `Constant` and `Enum`
**Example**
```php
"value"
];
}
```
6. Run the binary of the tool
```shell
composer dump-autoload -o --quiet
php ./vendor/bin/ts-const-enum.php generate
```
7. Start using the constants
## What's a makeshift enum in PHP?
Currently there're no enums in PHP. This will change with the release of PHP 8.2.
However, those enums need to be transformed to typescript enums too. In the meantime
i use constructs like these:
```php
class Membership {
public const FREE = "free";
public const PREMIUM = "premium";
public const TYPES = [
self::FREE,
self::PREMIUM
];
}
```
The constant "TYPES" is a makeshift enum. Those constructs will be transformed too. This will translate to the following enum
in Typescript
```Typescript
export enum Membership_TYPES {
'FREE' = 'free',
'PREMIUM' = 'premium',
}
```