ng-packagr/ng-entrypoint.schema.json

Compile and package Angular libraries in Angular Package Format (APF)

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "https://github.com/ng-packagr/ng-packagr/blob/master/src/ng-entrypoint.schema.json",
  "title": "NgPackageEntryConfig",
  "description": "JSON Schema for secondary entrypoint `ng-package.json` description file",
  "type": "object",
  "properties": {
    "$schema": {
      "type": "string"
    },
    "lib": {
      "description": "Description of the library's entry point.",
      "type": "object",
      "additionalProperties": false,
      "default": {},
      "properties": {
        "entryFile": {
          "description": "Entry file to the public API (default: `src/public_api.ts`).",
          "type": "string",
          "default": "src/public_api.ts"
        },
        "flatModuleFile": {
          "description": "Filename of the auto-generated flat module file (if empty, defaults to the package name as given in `package.json`).",
          "type": "string"
        },
        "cssUrl": {
          "description": "Embed assets in css file using data URIs - see https://css-tricks.com/data-uris",
          "type": "string",
          "enum": ["none", "inline"],
          "default": "inline"
        },
        "styleIncludePaths": {
          "description": "Any additional paths that should be used to resolve style imports",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "sass": {
          "description": "Options to pass to the sass preprocessor.",
          "type": "object",
          "properties": {
            "fatalDeprecations": {
              "description": "A set of deprecations to treat as fatal. If a deprecation warning of any provided type is encountered during compilation, the compiler will error instead. If a Version is provided, then all deprecations that were active in that compiler version will be treated as fatal.",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "silenceDeprecations": {
              "description": "A set of active deprecations to ignore. If a deprecation warning of any provided type is encountered during compilation, the compiler will ignore it instead.",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "futureDeprecations": {
              "description": "A set of future deprecations to opt into early. Future deprecations passed here will be treated as active by the compiler, emitting warnings as necessary.",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "required": [],
  "additionalProperties": false
}