npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

terraform-tool

v1.0.4

Published

NPM package to provision cloud infrastructure as code (IaC) using terraform

Downloads

21

Readme

terraform-tool

A node package that helps the developer to provision a cloud Infrastructure-as-Code using Terraform from your application.

Table of Contents

Installation

You can install this package using npm or yarn.

npm

npm i terraform-tool

yarn

yarn add terraform-tool

Usage

Here is a simple example to get you started:

import { Terraform } from 'terraform-tool';

const config = 'terraform configuration folder name' 

/*  terraform/main.tf
I have a terraform folder inside my project root directory and inside it main.tf file resides
You need to pass only the folder name or path only not the file name. 
As my file path is 'terraform/main.tf', I only pass 'terraform' in Terraform() function below
*/

const tf = new Terraform('terraform');

tf.init()
  .then(() => tf.plan())
  .then(output => console.log('Plan:', output))
  .then(() => tf.apply())
  .then(output => console.log('Apply:', output))
  .catch(error => console.error('Error:', error));
// Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

tf.destroy();

Functions

| Function | Description | Output | |---------|---------| ---------| | init() | The init function initializes a Terraform working directory. This command is used to set up the backend configuration, download provider plugins, and prepare the working directory for other Terraform operations. | A Promise that resolves to a string containing the standard output of the terraform init command. | | plan()| The plan function creates an execution plan, showing what actions Terraform will take to achieve the desired state of the infrastructure. This command is useful for reviewing proposed changes before applying them. | A Promise that resolves to a string containing the standard output of the terraform plan command. | | apply() | The apply function executes the actions proposed in a Terraform plan, applying changes to achieve the desired state of the infrastructure. The autoApprove parameter, when set to true, automatically approves the changes without prompting for confirmation. | A Promise that resolves to a string containing the standard output of the terraform apply command. | | destroy() | The destroy function removes all infrastructure managed by the Terraform configuration, effectively tearing down the environment. The autoApprove parameter, when set to true, automatically approves the destruction without prompting for confirmation. | A Promise that resolves to a string containing the standard output of the terraform destroy command. |

Scripts

Build

To compile the TypeScript files to JavaScript, run:

npm run build

Test

To run tests, use:

npm run test

Configuration

TypeScript Configuration

This package uses a tsconfig.json file for TypeScript configuration. Here is an example:

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "outDir": "./dist"
  },
}

Contributing

Support

LICENSE

This project is licensed under the MIT License - see the LICENSE file for details.