NPM.ProjectInit (NPM v0.6.0)

Copy Markdown View Source

Initializes an Elixir project for npm dependency management.

Creates package.json, .gitignore entries, and verifies configuration.

Summary

Functions

Returns a checklist of items to verify for npm setup.

Creates a package.json from project metadata.

Formats the checklist for display.

Checks if a project is already initialized for npm.

Returns true if all checklist items pass.

Functions

checklist(dir \\ ".")

@spec checklist(String.t()) :: [%{item: String.t(), ok: boolean()}]

Returns a checklist of items to verify for npm setup.

create_package_json(dir \\ ".", opts \\ [])

@spec create_package_json(
  String.t(),
  keyword()
) :: :ok | {:error, term()}

Creates a package.json from project metadata.

format_checklist(items)

@spec format_checklist([map()]) :: String.t()

Formats the checklist for display.

initialized?(dir \\ ".")

@spec initialized?(String.t()) :: boolean()

Checks if a project is already initialized for npm.

ready?(dir \\ ".")

@spec ready?(String.t()) :: boolean()

Returns true if all checklist items pass.