diff --git a/README.md b/README.md index bfab029..85a6b03 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # @build-in-blocks/dev.resources -![Latest Version](https://img.shields.io/npm/v/@build-in-blocks/dev.resources.svg?label=latest&color=brightgreen&style=flat-square) [![Npm package total downloads](https://flat.badgen.net/npm/dt/@build-in-blocks/dev.resources?color=blue)](https://npmjs.com/package/@build-in-blocks/dev.resources) ![build passing](https://img.shields.io/badge/build-passing-brightgreen?style=flat-square) +![Latest Version](https://img.shields.io/npm/v/@build-in-blocks/dev.resources.svg?label=latest&color=brightgreen&style=flat-square) ![NPM Downloads](https://img.shields.io/npm/d18m/%40build-in-blocks%2Fdev.resources?label=downloads%20(last%2018%20months)) ![build passing](https://img.shields.io/badge/build-passing-brightgreen?style=flat-square) [![License: AGPL v3.0](https://img.shields.io/badge/license-AGPL%20v3.0-blue.svg?style=flat-square)](https://www.gnu.org/licenses/agpl-3.0) [![All Contributors](https://img.shields.io/github/all-contributors/build-in-blocks/dev.resources?color=ee8449&style=flat-square)](#contributors) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat-square)](https://github.com/build-in-blocks/dev.resources/blob/develop/docs.contributors/README.md) @@ -44,7 +44,13 @@ Install the package as a `devDependency` in your project: npm install -D @build-in-blocks/dev.resources ```` -#### 2. Import needed resources +#### 2. When to install `typescript` + +If you are using both this library and [@build-in-blocks/dev.build](https://www.npmjs.com/package/@build-in-blocks/dev.build) together in your project, then you don't need to install `typescript` in your project (the **@build-in-blocks/dev.build** library already does that internally, relative to your project). + +Otherwise, you'll need to manually install `typescript` in your project. See `typescript` table in the general guide for more information: [Typescript compatibility and usage](https://github.com/build-in-blocks/.github/wiki/Repo-User-Guide-Extension#table-typescript-compatibility-and-usage). + +#### 3. Import needed resources Import and use what you need from the library in your `.ts` or `.js` file, for example: diff --git a/docs.contributors/README.md b/docs.contributors/README.md index d0c9436..e139c85 100644 --- a/docs.contributors/README.md +++ b/docs.contributors/README.md @@ -79,7 +79,7 @@ Follow the instructions to fork and clone this repository locally unto your comp npm link ../dev.resources ``` - - **Step 3:** Follow the usage instructions in the [root README.md](https://github.com/build-in-blocks/dev.resources), not from the beginning though; start from the **2. Import needed resources** section (and continue till the end). + - **Step 3:** Follow the usage instructions in the [root README.md](https://github.com/build-in-blocks/dev.resources), not from the beginning though; start from the **2. When to install typescript** section (and continue till the end). # diff --git a/docs.release/README.md b/docs.release/README.md index 3a10c36..d666c60 100644 --- a/docs.release/README.md +++ b/docs.release/README.md @@ -22,6 +22,8 @@ - **Ensure related-code works:** Check that all features to be released in the new version are working as expected, and are complete as shown on our project board. +- **General user guide update:** Check that the wiki for the general user guide has been updated when e.g. typescript version and compatibility has changed in the library's code, or a new **@build-in-blocks** library has been published etc. + - **Confirm package.json & docs content:** Always confirm that the content of the `package.json` (`scripts`, the `keywords` array etc.), as well as the **root README**, **user docs**, **contributor docs** and **release docs** content are in good/acceptable shape for the release. - **Version bumping:** Pending the time when we will automate the version bumping process, always remember to update the version number to a new one in the `package.json` file. diff --git a/docs.users/README.md b/docs.users/README.md index 15564c0..6fef9e7 100644 --- a/docs.users/README.md +++ b/docs.users/README.md @@ -11,9 +11,9 @@ User installation and setup instructions can in the [root README.md](https://git # -### Dependency Information +### User guide extension -`@build-in-blocks` framework libraries that have `dev.` in their name are only useful for local development, and should only be installed as a `devDependency` in your **web app**. If you are using a particular `dev.` package to build a **library** you wish to publish, and your library's end users will need to access that `dev.` packages' functionality or interface, in this case you will need to install it as a `dependency` instead. +More info on **@build-in-blocks** framework libraries in general can be found at: https://github.com/build-in-blocks/.github/wiki/Repo-User-Guide-Extension # diff --git a/package-lock.json b/package-lock.json index 72558ed..ab7e755 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@build-in-blocks/dev.resources", - "version": "1.0.2", + "version": "1.0.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@build-in-blocks/dev.resources", - "version": "1.0.2", + "version": "1.0.3", "license": "AGPL-3.0", "devDependencies": { "@build-in-blocks/dev.setup": "^1.0.2", @@ -3789,9 +3789,9 @@ } }, "node_modules/tinyexec": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.0.4.tgz", - "integrity": "sha512-u9r3uZC0bdpGOXtlxUIdwf9pkmvhqJdrVCH9fapQtgy/OeTTMZ1nqH7agtvEfmGui6e1XxjcdrlxvxJvc3sMqw==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.1.1.tgz", + "integrity": "sha512-VKS/ZaQhhkKFMANmAOhhXVoIfBXblQxGX1myCQ2faQrfmobMftXeJPcZGp0gS07ocvGJWDLZGyOZDadDBqYIJg==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 5d321e7..86abc8e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@build-in-blocks/dev.resources", - "version": "1.0.2", + "version": "1.0.3", "description": "Shared @build-in-blocks framework Typescript code development library.", "main": "./build/index.js", "module": "./build/index.js", diff --git a/src/shared/node.blocks-terminal-logger.ts b/src/shared/node.blocks-terminal-logger.ts index b243768..fce9061 100644 --- a/src/shared/node.blocks-terminal-logger.ts +++ b/src/shared/node.blocks-terminal-logger.ts @@ -20,7 +20,7 @@ export const blocksTerminalLogger = ({ internalPackage, userApp, errorSource, su const isSuggestionRequested = suggestion?.messageList?.length; //- const internalPackageNameText = `${internalPackage?.fullName} (internal)`; - const suggestionSectionTitle = `Suggestion${suggestion?.blocksConfig?.showCurrentState ? ' (based on current state)' : ''}:`; + const suggestionSectionTitle = `Suggestion${suggestion?.blocksConfig?.showCurrentState ? ' (based on current blocks config state)' : ''}:`; //- if (isInternalPackageErrorRequested) { console.error('--------------------------');