Skip to content

Commit 7a6152c

Browse files
authored
feat: Framework renamed (and beginnings of a new package structure. (#103)
The framework has a new name: **skele**. With this rename, we are taking the opportunity to start out the breakup of our monolithic core package into several ones that are useful outside of React environments. With the rename, the pacakage `@girders-elements/core` has been renamed to `@skele/classic` There is a migration guide at https://github.com/netceteragroup/skele/blob/feature/girders-elements-compatibility/packages/classic/docs/transitioning-from-girders-elements.md BREAKING CHANGE: See https://github.com/netceteragroup/skele/blob/feature/girders-elements-compatibility/packages/classic/docs/transitioning-from-girders-elements.md
1 parent 5951cf6 commit 7a6152c

File tree

113 files changed

+251
-188
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+251
-188
lines changed

.eslintignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
node_modules/
22
dist/
33
coverage/
4-
packages/core/src/vendor
4+
packages/classic/src/vendor

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,28 @@
55

66
Skele is an architectural framework that assists building
77
**data-driven** apps with **[React](https://facebook.github.io/react/)** or
8-
**[React Native](https://facebook.github.io/react-native/)**.
8+
**[React Native](https://facebook.github.io/react-native/)**.
99
It is extremely well-suited for creating highly **dynamic UIs**,
1010
that are driven by back-end systems (like Content Management Systems).
1111

1212
## Packages
1313

1414
The repository is a monorepo that is composed of several NPM packages.
1515

16-
| Package | Description |
17-
|---|---|
18-
|[Core](/packages/core)| The core library. |
19-
|[Config](/packages/config)| Library for setting up layered app configuration. |
20-
|[Components](/packages/components)| Collection of helpful custom components. |
16+
| Package | Description |
17+
| ---------------------------------- | ------------------------------------------------- |
18+
| [Classic](/packages/classic) | The library as a (still) monolithic package. |
19+
| [Config](/packages/config) | Library for setting up layered app configuration. |
20+
| [Components](/packages/components) | Collection of helpful custom components. |
2121

2222
## Documentation
2323

2424
Check out the API documentation [here](https://netcetera.gitbooks.io/skele/).
2525

26+
## Transitioning from versions prior to 1.0.0-alpha.27
27+
28+
Please check this [manual](./packages/classc/docs/transitioning-from-girders-elements.md)
29+
2630
## License
2731

2832
[MIT](./LICENSE) © [Netcetera](https://www.netcetera.com)

SUMMARY.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
11
# Summary
22

33
* [Introduction](/README.md)
4-
* [Core](/packages/core/README.md)
5-
* [UI](/packages/core/docs/api/ui.md)
6-
* [Read](/packages/core/docs/api/read.md)
7-
* [Effect](/packages/core/docs/api/effect.md)
8-
* [Update](/packages/core/docs/api/update.md)
9-
* [Transform](/packages/core/docs/api/transform.md)
10-
* [Enrich](/packages/core/docs/api/enrich.md)
11-
* [Enhance](/packages/core/docs/api/enhance.md)
12-
* [Data](/packages/core/docs/api/data.md)
13-
* [Zip](/packages/core/docs/api/zip.md)
14-
* [Actions](/packages/core/docs/api/actions.md)
15-
* [EntryPoint](/packages/core/docs/api/entry-point.md)
16-
* [Kernel](/packages/core/docs/api/kernel.md)
17-
* [Subsystem](/packages/core/docs/api/subsystem.md)
18-
* [Default Subsystems](/packages/core/docs/api/default-subsystems.md)
19-
* [Registry](/packages/core/docs/api/registry.md)
20-
* [Prop Names](/packages/core/docs/api/prop-names.md)
21-
* [HTTP](/packages/core/docs/api/http.md)
4+
* [Classic](packages/classic/README.md)
5+
* [UI](packages/classic/docs/api/ui.md)
6+
* [Read](packages/classic/docs/api/read.md)
7+
* [Effect](packages/classic/docs/api/effect.md)
8+
* [Update](packages/classic/docs/api/update.md)
9+
* [Transform](packages/classic/docs/api/transform.md)
10+
* [Enrich](packages/classic/docs/api/enrich.md)
11+
* [Enhance](packages/classic/docs/api/enhance.md)
12+
* [Data](packages/classic/docs/api/data.md)
13+
* [Zip](packages/classic/docs/api/zip.md)
14+
* [Actions](packages/classic/docs/api/actions.md)
15+
* [EntryPoint](packages/classic/docs/api/entry-point.md)
16+
* [Kernel](packages/classic/docs/api/kernel.md)
17+
* [Subsystem](packages/classic/docs/api/subsystem.md)
18+
* [Default Subsystems](packages/classic/docs/api/default-subsystems.md)
19+
* [Registry](packages/classic/docs/api/registry.md)
20+
* [Prop Names](packages/classic/docs/api/prop-names.md)
21+
* [HTTP](packages/classic/docs/api/http.md)
22+
* [Transitioning from Girders Elements](packages/classic/docs/transitioning-from-girders-elements.md)
2223
* [Config](/packages/config/README.md)
2324
* [Components](/packages/components/README.md)

package.json

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"name": "skele-container",
33
"private": true,
4-
"description": "Skele is an architectural framework that assists with building data-driven apps with React or React Native.",
4+
"description":
5+
"Skele is an architectural framework that assists with building data-driven apps with React or React Native.",
56
"repository": {
67
"type": "git",
78
"url": "git+https://github.com/netceteragroup/skele.git"
@@ -19,19 +20,26 @@
1920
"coverage": "jest --coverage",
2021
"coverage-report": "cat ./coverage/lcov.info | coveralls",
2122
"lint": "eslint .",
22-
"es5": "yarn run es5:core && yarn run es5:config && yarn run es5:components",
23-
"es5:core": "babel -q packages/core/src --out-dir packages/core/dist/es5",
24-
"es5:config": "babel -q packages/config/src --out-dir packages/config/dist/es5",
25-
"es5:components": "babel -q packages/components/src --out-dir packages/components/dist/es5",
26-
"clean": "yarn run clean:core && yarn run clean:config && yarn run clean:components",
27-
"clean:core": "del-cli packages/core/dist",
23+
"es5":
24+
"yarn run es5:classic && yarn run es5:config && yarn run es5:components",
25+
"es5:classic":
26+
"babel -q packages/classic/src --out-dir packages/classic/dist/es5",
27+
"es5:config":
28+
"babel -q packages/config/src --out-dir packages/config/dist/es5",
29+
"es5:components":
30+
"babel -q packages/components/src --out-dir packages/components/dist/es5",
31+
"clean":
32+
"yarn run clean:classic && yarn run clean:config && yarn run clean:components",
33+
"clean:classic": "del-cli packages/classic/dist",
2834
"clean:config": "del-cli packages/config/dist",
2935
"clean:components": "del-cli packages/components/dist",
3036
"build": "yarn run clean && yarn run test && yarn run lint && yarn run es5",
31-
"release:test-token": "test -n \"$CONVENTIONAL_GITHUB_RELEASER_TOKEN\" || (echo 'Setup your github autho token first: https://github.com/conventional-changelog/conventional-github-releaser#cli' && exit 1)",
37+
"release:test-token":
38+
"test -n \"$CONVENTIONAL_GITHUB_RELEASER_TOKEN\" || (echo 'Setup your github autho token first: https://github.com/conventional-changelog/conventional-github-releaser#cli' && exit 1)",
3239
"release:publish": "lerna publish",
3340
"release:github": "conventional-github-releaser -p angular",
34-
"release": "yarn run build && yarn run release:test-token && yarn run release:publish && yarn run release:github"
41+
"release":
42+
"yarn run build && yarn run release:test-token && yarn run release:publish && yarn run release:github"
3543
},
3644
"engines": {
3745
"node": ">= 7.4.0",
@@ -78,17 +86,13 @@
7886
},
7987
"jest": {
8088
"setupTestFrameworkScriptFile": "./scripts/test-setup.js",
81-
"modulePathIgnorePatterns": [
82-
"/dist/es5/"
83-
],
89+
"modulePathIgnorePatterns": ["/dist/es5/"],
8490
"roots": [
85-
"<rootDir>/packages/core",
91+
"<rootDir>/packages/classic",
8692
"<rootDir>/packages/config",
8793
"<rootDir>/packages/components"
8894
],
89-
"testMatch": [
90-
"**/__tests__/**/*.js"
91-
],
95+
"testMatch": ["**/__tests__/**/*.js"],
9296
"collectCoverageFrom": [
9397
"**/*.js",
9498
"!**/__tests__/**",
@@ -97,7 +101,5 @@
97101
"!**/dist/es5/**"
98102
]
99103
},
100-
"workspaces": [
101-
"packages/*"
102-
]
104+
"workspaces": ["packages/*"]
103105
}

0 commit comments

Comments
 (0)