Skip to content

Commit 9a526b8

Browse files
Merge branch 'main' of github.com:razroo/razzle
2 parents ce1bb22 + 79a9768 commit 9a526b8

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2013-present Pagar.me Pagamentos S/A
3+
Copyright (c) 2022-present Razroo LLC
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,39 @@
11
![Razzle Logo](assets/razzle-logo-small.png "Razzle - Extensible Codemod Library") ![Razzle Logo](assets/razroo-certified-logo.png "Razroo Certified")
22

3-
Razzle is an extensible, easy to understand, easy contribute, easy to use Codemod library. Razzle-dazzle your codebase like you've never before.
3+
Razzle is an extensible, easy to understand, easy to contribute, easy to use Codemod library. Razzle-dazzle your codebase like you've never before.
44

5-
# Novelty behind Razzle library
5+
## Novelty behind Razzle library
6+
7+
### Easy To Understand
68

79
What the Razzle library does that is unique, is that it creates a unified interface across different programming languages. It uses a simple object to make modifications. e.g.
810

9-
### Typescript
11+
#### Typescript
1012
```
1113
{
1214
"import": '{ NgModule }',
1315
"path": '@angular/core'
1416
}
1517
```
1618

17-
### SCSS
19+
#### SCSS
1820
```
1921
{
2022
"import": '',
2123
"path": 'libs/common/styles/razroo-styles.scss'
2224
}
2325
```
2426

27+
So your engineers can understand how it works for one programming language and use the same syntax for a different programming language.
28+
29+
### Easy To Contribute
30+
Razzle uses a tree of switch case statements to determine type of codemod to use. Simply specify programming language e.g. `angular` and fileType e.g. `.ts` and Codemod will take care of the rest.
31+
32+
### Extensible
33+
If you want to add your own custom codemods, or add your own, you can simply plug and play to the Razroo codemod library.
34+
2535
## Assumption Made
26-
Razzle is always used in an editing circumstance. There is no need to speicify that file is being editied. Razzle will update the string
36+
Razzle is always used in an editing circumstance. There is no need to speicify that file is being edited.
2737

2838
## Benefits of such
2939
1. This will be consumer facing. By allowing a singular object, we can simplify the frontend shown to users in the content management system.

0 commit comments

Comments
 (0)