Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions docs.users/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ User installation and setup instructions can in the [root README.md](https://git
````
export interface BlocksConfig {
devBuild?: {
srcFolderRoot?: string;
srcCodeFolder?: string;
entryFileName?: string;
};
}
Expand All @@ -33,7 +33,7 @@ User installation and setup instructions can in the [root README.md](https://git
|Property | Type| Required| Description|
|:-- |:-- |:-- |:-- |
|`devBuild` |`object` |No |A nested object containing settings specific to the development build process. |
|`devBuild.srcFolderRoot` |`string` |No |The path to the source directory. Overrides the default `'src'`. |
|`devBuild.srcCodeFolder` |`string` |No |The path to the source directory. Overrides the default `'src'`. |
|`devBuild.entryFileName` |`string` |No | The name of the main entry file (without extension). Overrides the default `'index'`.|

**Usage Example**
Expand All @@ -47,7 +47,7 @@ User installation and setup instructions can in the [root README.md](https://git

const myConfig: BlocksConfig = {
devBuild: {
srcFolderRoot: 'app',
srcCodeFolder: 'app',
entryFileName: 'main'
}
};
Expand All @@ -67,7 +67,7 @@ User installation and setup instructions can in the [root README.md](https://git

|Property | Type| Default| Description|
|:-- |:-- |:-- |:-- |
|`srcFolderRoot` |`string` |`'src'` |The name of the directory where source files are located. |
|`srcCodeFolder` |`string` |`'src'` |The name of the directory where source files are located. |
|`entryFileName` |`string` |`'index'` |The base name of the main entry point file. |
|`fileExtension` |`string` |`'.ts'` |The default file extension for the project (includes the leading dot). |

Expand All @@ -85,7 +85,7 @@ User installation and setup instructions can in the [root README.md](https://git
* Result: "src/index.ts"
*/

const defaultEntryPoint = `${_default.srcFolderRoot}/${_default.entryFileName}${_default.fileExtension}`;
const defaultEntryPoint = `${_default.srcCodeFolder}/${_default.entryFileName}${_default.fileExtension}`;

console.log(`Looking for entry file at: ${defaultEntryPoint}`);
````
Expand All @@ -97,7 +97,7 @@ User installation and setup instructions can in the [root README.md](https://git
````
import { _default } from '@build-in-blocks/dev.resources';

const root = myConfig.devBuild?.srcFolderRoot || _default.srcFolderRoot;
const root = myConfig.devBuild?.srcCodeFolder || _default.srcCodeFolder;
console.log(`Starting build from: ${root}`);
````

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@build-in-blocks/dev.resources",
"version": "1.0.0",
"version": "1.0.1",
"description": "Shared @build-in-blocks framework Typescript code development library.",
"main": "./build/index.js",
"module": "./build/index.js",
Expand Down
2 changes: 1 addition & 1 deletion src/shared/types/web.blocks-app.types.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
export interface BlocksConfig {
devBuild?: {
srcFolderRoot?: string;
srcCodeFolder?: string;
entryFileName?: string;
};
}
2 changes: 1 addition & 1 deletion src/shared/web.blocks-app.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
export const _default = {
srcFolderRoot: 'src',
srcCodeFolder: 'src',
entryFileName: 'index',
//-
fileExtension: '.ts',
Expand Down
Loading