ngx-config-splitter v0.0.1
What is this for?
This repository allows you to split your angular.json
, nx.json
and tsconfig.json
into multiple files in many directories (apps, libs, etc). This is meant to avoid multiple lines of code on the same file and conflicts.
How does it work?
In your project root, you'll need to configure *.base.json
files.
angular.base.json
nx.base.json
tsconfig.base.json
Essentially, these files will be a copy of your current respective files. This base file is meant to hold everything that won't change adding a lib or an app, configurations and so on.
IMPORTANT: To avoid further conflicts on the original files, you should put tsconfig
, nx
and angular.json
file on .gitignore
After configuring base files, you'll need to create inside the lib/app directory a file called project.config.json
, if your lib is called ui-kit, then here's a example of a project.config.json
for your lib
{
"angular": {
"ui-kit": {
// angular.json stuff inside 'projects'
}
},
"nx": {
"ui-kit: { "tags": [] }
},
"tsconfig": {
// stuff inside `compilerOptions.paths`
"@org/ui-kit": [ "paths/ui-kit/index" ]
}
}
Finally,
To concatenate everything run the schematic command:
ng generate ngx-config-splitter:merge
I recommend you to run this command before any serve
, build
, generate
command to ensure you'll always have your files updated.
Adding it to Nx-workspace schematic to generate libs and apps with this feature
import { writeProjectConfigFiles } from 'ngx-config-splitter';
function writeProjectConfigFiles(
schema: any,
rootDirectory: string,
fileName: string,
keyPath: string = 'projects'
)
export default function(schema: any): Rule {
return chain([
externalSchematic('@nrwl/angular', 'lib', {
name: schema.name
}),
writeProjectConfigFiles(schema, 'libs', 'nx'),
writeProjectConfigFiles(schema, 'libs', 'angular'),
writeProjectConfigFiles(schema, 'libs', 'tsconfig', 'compilerOptions.paths')
]);
}
4 years ago