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.

Sign up for GitHub

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

Jump to bottom

Add modules.md #236

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add modules.md #236

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
57c6d40
Add coding_rules.md
nadongguri Feb 19, 2018
c889398
Update coding_rules.md
nadongguri Feb 20, 2018
86faaa1
Rename coding_rules.md to modules.md
nadongguri Feb 20, 2018
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
11 changes: 11 additions & 0 deletions docs/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Coding Rules For Modules
This document explains how to write code for typescript modules in bacardi project.

- ts file should have one module such as a class, an interface or so on.
- If there are more than one class, interface or so on, create a folder, split them.
- index.ts should be in a folder.
 - ts files can be imported in the same folder. For the other cases, import index.ts only.
- The processing order is pro parser, construtor and generator.
- There is a dependency in reverse order.
- ts files in types folder are split into each folder.
- The exception is base folder.