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
85 changes: 0 additions & 85 deletions CONTRIBUTING.md

This file was deleted.

17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# single-spa-angular
<p align="center">
<img src="https://raw.githubusercontent.com/single-spa/single-spa-angular/refs/heads/v19.0.0/docs/assets/logo-256.png" alt="@single-spa-community/angular logo" width="256" height="256" />
</p>

# @single-spa-community/angular

Helpers for building [single-spa](https://github.com/single-spa/single-spa) applications which use Angular.

Expand All @@ -12,4 +16,13 @@ See [documentation on single-spa.js.org](https://single-spa.js.org/docs/ecosyste

## Project Status

This project needs new maintainers. The single-spa core team does not have the Angular expertise needed to continously support all versions of Angular, as none of us use single-spa-angular in any of our serious projects. We could use help keeping up with the six month release cadence of Angular, diagnosing problems in the issue queues, and providing support in the single-spa Slack workspace. Angular is the framework that is hardest to support in the single-spa ecosystem, and we rely on the community to help us with it. If you have interest in helping with the maintenance of this project, please let us know!
The package has been republished under the `@single-spa-community` scope due to a change in maintainership.

> **Note:** This package is the continuation of the original `single-spa-angular` package. If you are migrating from `single-spa-angular`, simply update the package name in your dependencies — no other changes are required.

## Compatibility

| `@single-spa-community/angular` | Angular |
| ------------------------------- | ------- |
| `20.x` | `20.x` |
| `19.x` | `19.x` |
2 changes: 1 addition & 1 deletion apps/chat/webpack.config.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export { default } from '../../libs/single-spa-angular/webpack';
export { default } from '../../libs/single-spa-community-angular/webpack';
2 changes: 1 addition & 1 deletion apps/navbar/webpack.config.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export { default } from '../../libs/single-spa-angular/webpack';
export { default } from '../../libs/single-spa-community-angular/webpack';
2 changes: 1 addition & 1 deletion apps/parcel/webpack.config.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export { default } from '../../libs/single-spa-angular/webpack';
export { default } from '../../libs/single-spa-community-angular/webpack';
2 changes: 1 addition & 1 deletion apps/shop/webpack.config.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export { default } from '../../libs/single-spa-angular/webpack';
export { default } from '../../libs/single-spa-community-angular/webpack';
17 changes: 0 additions & 17 deletions libs/single-spa-angular/project.json

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"$schema": "../../../node_modules/ng-packagr/ng-package.schema.json",
"lib": {
"entryFile": "src/index.ts",
"flatModuleFile": "single-spa-angular-parcel"
"flatModuleFile": "single-spa-community-angular-elements"
}
}
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import type { LifeCycles } from 'single-spa';
import type { NgElement } from '@angular/elements';
import {
BaseSingleSpaAngularOptions,
type BaseSingleSpaAngularOptions,
getContainerElementAndSetTemplate,
} from 'single-spa-angular/internals';
} from '@single-spa-community/angular/internals';

import { BootstrappedSingleSpaAngularElementsOptions } from './types';
import type { BootstrappedSingleSpaAngularElementsOptions } from './types';

const defaultOptions: BootstrappedSingleSpaAngularElementsOptions = {
element: null,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { ApplicationRef, NgModuleRef } from '@angular/core';
import { NgElement } from '@angular/elements';
import { BaseSingleSpaAngularOptions } from 'single-spa-angular/internals';
import type { ApplicationRef, NgModuleRef } from '@angular/core';
import type { NgElement } from '@angular/elements';
import type { BaseSingleSpaAngularOptions } from '@single-spa-community/angular/internals';

export interface BootstrappedSingleSpaAngularElementsOptions extends BaseSingleSpaAngularOptions {
ngModuleRefOrAppRef: NgModuleRef<any> | ApplicationRef | null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"$schema": "../../../node_modules/ng-packagr/ng-package.schema.json",
"lib": {
"entryFile": "src/index.ts",
"flatModuleFile": "single-spa-angular-internals"
"flatModuleFile": "single-spa-community-angular-internals"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
"dest": "../../lib",
"lib": {
"flatModuleFile": "single-spa-angular",
"flatModuleFile": "single-spa-community-angular",
"entryFile": "index.ts"
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "../node_modules/ng-packagr/ng-package.schema.json",
"name": "single-spa-angular",
"name": "@single-spa-community/angular",
"version": "20.0.0",
"description": "Helpers for building single-spa applications which use Angular 2",
"schematics": "./schematics/schematics.json",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"$schema": "../../../node_modules/ng-packagr/ng-package.schema.json",
"lib": {
"entryFile": "src/index.ts",
"flatModuleFile": "single-spa-angular-elements"
"flatModuleFile": "single-spa-community-angular-parcel"
}
}
17 changes: 17 additions & 0 deletions libs/single-spa-community-angular/project.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "single-spa-community-angular",
"$schema": "../../node_modules/nx/schemas/project-schema.json",
"projectType": "library",
"sourceRoot": "libs/single-spa-community-angular/src",
"prefix": "single-spa-community-angular",
"targets": {
"build": {
"executor": "@nx/angular:package",
"options": {
"tsConfig": "libs/single-spa-community-angular/tsconfig.lib.json",
"project": "libs/single-spa-community-angular/ng-package.json"
}
}
},
"tags": []
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { ApplicationRef, NgModuleRef, NgZone } from '@angular/core';
import type { LifeCycles } from 'single-spa';
import { getContainerElementAndSetTemplate } from 'single-spa-angular/internals';
import { getContainerElementAndSetTemplate } from '@single-spa-community/angular/internals';

import { SingleSpaPlatformLocation } from './extra-providers';
import type { SingleSpaAngularOptions, BootstrappedSingleSpaAngularOptions } from './types';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { NgModuleRef, Type, NgZone, ApplicationRef } from '@angular/core';
import type { AppProps } from 'single-spa';
import type { BaseSingleSpaAngularOptions } from 'single-spa-angular/internals';
import type { BaseSingleSpaAngularOptions } from '@single-spa-community/angular/internals';

export interface SingleSpaAngularOptions<
T = Record<string, unknown>,
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "single-spa-angular",
"name": "@single-spa-community/angular",
"version": "0.0.0",
"description": "Helpers for building single-spa applications which use Angular 2+",
"repository": {
Expand Down Expand Up @@ -34,7 +34,7 @@
"test": "yarn clean && jest",
"lint": "eslint apps libs --ext ts",
"// - SINGLE-SPA-ANGULAR": "Scripts for building single-spa-angular",
"build:single-spa-angular": "nx build single-spa-angular --skip-nx-cache && cpx README.md lib",
"build:single-spa-angular": "nx build single-spa-community-angular --skip-nx-cache && cpx README.md lib",
"// - WEBPACK": "Scripts for building Webpack config transformer",
"build:webpack": "rimraf lib/lib && tsc -p tsconfig.webpack.json",
"// - SYSTEM": "Scripts for building singla-spa-angular in SystemJS format",
Expand Down
16 changes: 8 additions & 8 deletions system/rollup.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,23 @@ const packages = ['2022']
.map(ecma => [
{
ecma,
angularPackage: 'single-spa-angular/internals',
filename: 'single-spa-angular-internals',
angularPackage: '@single-spa-community/angular/internals',
filename: 'single-spa-community-angular-internals',
},
{
ecma,
angularPackage: 'single-spa-angular',
filename: 'single-spa-angular',
angularPackage: '@single-spa-community/angular',
filename: 'single-spa-community-angular',
},
{
ecma,
angularPackage: 'single-spa-angular/elements',
filename: 'single-spa-angular-elements',
angularPackage: '@single-spa-community/angular/elements',
filename: 'single-spa-community-angular-elements',
},
{
ecma,
angularPackage: 'single-spa-angular/parcel',
filename: 'single-spa-angular-parcel',
angularPackage: '@single-spa-community/angular/parcel',
filename: 'single-spa-community-angular-parcel',
},
])
.flat();
Expand Down
14 changes: 10 additions & 4 deletions tsconfig.base.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@
"compilerOptions": {
"baseUrl": ".",
"paths": {
"single-spa-angular": ["libs/single-spa-angular/index.ts"],
"single-spa-angular/elements": ["libs/single-spa-angular/elements/src/index.ts"],
"single-spa-angular/internals": ["libs/single-spa-angular/internals/src/index.ts"],
"single-spa-angular/parcel": ["libs/single-spa-angular/parcel/src/index.ts"]
"@single-spa-community/angular": ["libs/single-spa-community-angular/index.ts"],
"@single-spa-community/angular/elements": [
"libs/single-spa-community-angular/elements/src/index.ts"
],
"@single-spa-community/angular/internals": [
"libs/single-spa-community-angular/internals/src/index.ts"
],
"@single-spa-community/angular/parcel": [
"libs/single-spa-community-angular/parcel/src/index.ts"
]
},
"target": "es2015",
"module": "esnext",
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.webpack.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@
"module": "CommonJS",
"types": ["node"]
},
"include": ["./libs/single-spa-angular/webpack/index.ts"]
"include": ["./libs/single-spa-community-angular/webpack/index.ts"]
}
Loading
Loading