Skip to content

Commit

Permalink
refactor(app): remove old project name
Browse files Browse the repository at this point in the history
* refactor(app): remove old project name

* refactor(docs): add missed old project name
  • Loading branch information
Villanuevand committed Dec 13, 2019
1 parent 1b41eb4 commit d7ec836
Show file tree
Hide file tree
Showing 10 changed files with 36 additions and 36 deletions.
4 changes: 2 additions & 2 deletions .vscode/settings.json
Expand Up @@ -27,9 +27,9 @@
"editorGroup.border": "#1b2c8f"
},
"files.exclude": {
"**/coulson/bin/**/*": true
"**/scully/bin/**/*": true
},
"files.watcherExclude": {
"**/coulson/bin/**": true
"**/scully/bin/**": true
}
}
10 changes: 5 additions & 5 deletions Documentation/demosteps.md
Expand Up @@ -8,7 +8,7 @@ cd demo
# start `ng build --prod --sourceMap --watch` in another terminal
# we are working with the build files

ng add @herodevs/coulson-generate
ng add @herodevs/scully-generate
# Lets make it look a bit better
# replace app-component.html with snippet-2
# add snippet-3 to styles.css
Expand All @@ -22,14 +22,14 @@ ng g m home --route home --module app.module
# paste snippet-4 into home.component.ts
# replace home.component.html with snippet-5

ng g @herodevs/coulson-generate:blog
ng g @herodevs/scully-generate:blog
# the following steps should be done by the blog generator
# add snippet-1 to app-routing.module

ng build
npm run coulson
npm run scully
# serve up the static site.
npm run coulson serve
npm run scully serve

```

Expand Down Expand Up @@ -106,7 +106,7 @@ body {
snippet-4
```typescript
index$ = this.crs.available$;
constructor(private crs: CoulsonRoutesService) {}
constructor(private crs: ScullyRoutesService) {}
/** NTS: do not forget to add the import! **/
```

Expand Down
20 changes: 10 additions & 10 deletions Documentation/gettingStarted.md
@@ -1,48 +1,48 @@
# Gettings started with coulson
# Gettings started with scully

In an existing Angular app, first install coulson by using the CLI:
In an existing Angular app, first install scully by using the CLI:

```bash
ng add @herodevs/coulson-generate --blog
ng add @herodevs/scully-generate --blog
```


When that is done, the following things will have happened.

1. We installed all the dependencies most of those are only developer dependencies.
2. We added a `coulson.json` sample configuration.
2. We added a `scully.json` sample configuration.


The `--blog` is optional and will add the below in one step.

1. add a folder `./blog` to the project root.
2. add a lazy loaded blog module to your app.
3. put in a sample route to this module
4. added a blog component, that shows how to sue the `<coulson-content>` component
4. added a blog component, that shows how to sue the `<scully-content>` component
5. put in a sample mardown first blog entry in the folder

You can do this later on by using:

```bash
ng generate @herodevs/coulson-generate:blog
ng generate @herodevs/scully-generate:blog
```

To add a page to the blog you can use:

```bash
ng g @herodevs/coulson-generate:post --title=MyBeautifulWebApp
ng g @herodevs/scully-generate:post --title=MyBeautifulWebApp
```

This will create a new MD file in the `./blog` folder. if you provided the optional `--title` option, it will use the name given, otherwise it will create a file named `blogxxx.md` where xxx is a number. it warns when the file already exists.

A blog file will start with an header. We are using the standard [front-matter](https://github.com/jxson/front-matter) to extract this header.
The meta-data available in there will be available to you by injecting the `CoulsonRoutesService`
The meta-data available in there will be available to you by injecting the `ScullyRoutesService`


Now you are ready run the coulson you can do this by:
Now you are ready run the scully you can do this by:

```bash
npm run coulson:generate
npm run scully:generate
```
When are done with this, inside your dist folder is a static folder, with all pages generated.

Expand Down
8 changes: 4 additions & 4 deletions Documentation/schematics.md
@@ -1,7 +1,7 @@
# schematics


### @herodevs/coulson
### @herodevs/scully

Generate function for create static pages.

Expand All @@ -10,23 +10,23 @@ Generate function for create static pages.

#### Steps to use

- `ng add @herodevs/coulson`
- `ng add @herodevs/scully`

#### Options

WIP

#### Dev mode

copy the build for get the new coulson version
copy the build for get the new scully version
- run `npm run copy:generate`

Dev mode
- run `npm run dev`
- `npm run schematics`


We use : `"schematics": "schematics .:coulson --debug=false --force"`
We use : `"schematics": "schematics .:scully --debug=false --force"`
- `debug`is for create the files
- `force` is for rewrite the created files

Expand Down
4 changes: 2 additions & 2 deletions README.md
@@ -1,4 +1,4 @@
# Coulson
# Scully

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

Expand All @@ -18,4 +18,4 @@ This is the initial setup.

## bazel things

All with ibazel is watch mode, the same without the i is no-watch
All with ibazel is watch mode, the same without the i is no-watch
4 changes: 2 additions & 2 deletions WORKSPACE
Expand Up @@ -4,7 +4,7 @@
# See https://docs.bazel.build/versions/master/build-ref.html#workspace
workspace(
# How this workspace would be referenced with absolute labels from another workspace
name = "coulson",
name = "scully",
# Map the @npm bazel workspace to the node_modules directory.
# This lets Bazel use the same node_modules as other local tooling.
managed_directories = {"@npm": ["node_modules"]},
Expand Down Expand Up @@ -39,4 +39,4 @@ load("@npm_bazel_typescript//:index.bzl", "ts_setup_workspace")
ts_setup_workspace()

load("@build_bazel_rules_nodejs//:index.bzl", "node_repositories")
node_repositories(package_json = ["//:package.json"])
node_repositories(package_json = ["//:package.json"])
4 changes: 2 additions & 2 deletions scully.json
@@ -1,8 +1,8 @@
{
// This is a sample Coulson config file
// This is a sample Scully config file
// The projectroot is mandatory
"projectRoot": "./projects/sampleBlog/src/app",
// Define coulson augmented routes here
// Define scully augmented routes here
"routes": {
/**
* use the exact routename from your Angular application.
Expand Down
12 changes: 6 additions & 6 deletions scully/BUILD.bazel
Expand Up @@ -6,7 +6,7 @@ package(default_visibility=["//visibility:public"])
load("@npm_bazel_typescript//:index.bzl", "ts_library")

exports_files([
"tsconfig.coulson.json"
"tsconfig.scully.json"
])

load("@npm//typescript:index.bzl", "tsc")
Expand All @@ -21,7 +21,7 @@ tsc(
args = [
"--outDir",
"$@",
"--lib",
"--lib",scully
"es2017,dom",
"--downlevelIteration",
"--declaration",
Expand All @@ -32,10 +32,10 @@ tsc(
)

ts_library(
name = "coulson-ts",
tsconfig = "tsconfig.coulson.json",
name = "scully-ts",
tsconfig = "tsconfig.scully.json",
srcs = glob(["*.ts", "**/*.ts"]),
module_name = "@herodevs/coulson",
module_name = "@herodevs/scully",
deps = [
"@npm//fs-extra",
"@npm//rxjs",
Expand Down Expand Up @@ -65,7 +65,7 @@ load("@build_bazel_rules_nodejs//:index.bzl", "nodejs_binary")

nodejs_binary(
name = "run",
data = [":coulson-ts"],
data = [":scully-ts"],
entry_point = ":index.ts",
args = ["serve"],
visibility = ["//visibility:public"],
Expand Down
2 changes: 1 addition & 1 deletion scully/tsconfig.scully.json
@@ -1,7 +1,7 @@
{
"compileOnSave": false,
"compilerOptions": {
"baseUrl": "./coulson",
"baseUrl": "./scully",
"declaration": true,
"downlevelIteration": true,
"esModuleInterop": true,
Expand Down
4 changes: 2 additions & 2 deletions testPlgin/tsconfig.custom-coulson.json
Expand Up @@ -16,9 +16,9 @@
"typeRoots": ["../node_modules/@types"],
"paths": {
"*": ["node_modules/*"],
"@herodevs/coulson": ["../coulson"]
"@herodevs/scully": ["../scully"]
}
},
"files": [ "coulson.custom.ts"],
"files": [ "scully.custom.ts"],
"exclude": ["./bin/**/*"]
}

0 comments on commit d7ec836

Please sign in to comment.