Add square-root (#1587)

* Add `square-root`

* Format files

* Add custom metadata fields

Author: BNAndras

config.json

@@ -416,6 +416,14 @@
           "time"
         ]
       },
+      {
+        "slug": "square-root",
+        "name": "Square Root",
+        "uuid": "bf4a0802-334b-4ed7-9ade-a3ef5fa6878e",
+        "practices": [],
+        "prerequisites": [],
+        "difficulty": 2
+      },
       {
         "slug": "reverse-string",
         "name": "Reverse String",

exercises/practice/square-root/.docs/instructions.md

@@ -0,0 +1,18 @@
+# Instructions
+
+Your task is to calculate the square root of a given number.
+
+- Try to avoid using the pre-existing math libraries of your language.
+- As input you'll be given a positive whole number, i.e. 1, 2, 3, 4…
+- You are only required to handle cases where the result is a positive whole number.
+
+Some potential approaches:
+
+- Linear or binary search for a number that gives the input number when squared.
+- Successive approximation using Newton's or Heron's method.
+- Calculating one digit at a time or one bit at a time.
+
+You can check out the Wikipedia pages on [integer square root][integer-square-root] and [methods of computing square roots][computing-square-roots] to help with choosing a method of calculation.
+
+[integer-square-root]: https://en.wikipedia.org/wiki/Integer_square_root
+[computing-square-roots]: https://en.wikipedia.org/wiki/Methods_of_computing_square_roots

exercises/practice/square-root/.docs/introduction.md

@@ -0,0 +1,10 @@
+# Introduction
+
+We are launching a deep space exploration rocket and we need a way to make sure the navigation system stays on target.
+
+As the first step in our calculation, we take a target number and find its square root (that is, the number that when multiplied by itself equals the target number).
+
+The journey will be very long.
+To make the batteries last as long as possible, we had to make our rocket's onboard computer very power efficient.
+Unfortunately that means that we can't rely on fancy math libraries and functions, as they use more power.
+Instead we want to implement our own square root calculation.

exercises/practice/square-root/.meta/config.json

@@ -0,0 +1,27 @@
+{
+  "authors": [
+    "BNAndras"
+  ],
+  "files": {
+    "solution": [
+      "square-root.ts"
+    ],
+    "test": [
+      "square-root.test.ts"
+    ],
+    "example": [
+      ".meta/proof.ci.ts"
+    ]
+  },
+  "blurb": "Given a natural radicand, return its square root.",
+  "custom": {
+    "version.tests.compatibility": "jest-29",
+    "flag.tests.task-per-describe": false,
+    "flag.tests.may-run-long": false,
+    "flag.tests.includes-optional": false,
+    "flag.tests.jest": true,
+    "flag.tests.tstyche": false
+  },
+  "source": "wolf99",
+  "source_url": "https://github.com/exercism/problem-specifications/pull/1582"
+}

exercises/practice/square-root/.meta/proof.ci.ts

@@ -0,0 +1,12 @@
+export function squareRoot(radicand: number): number {
+  if (radicand === 1) {
+    return 1
+  }
+
+  let guess = Math.floor(radicand / 2)
+  for (let i = 0; i < 10; i++) {
+    guess = Math.floor((guess + radicand / guess) / 2)
+  }
+
+  return guess
+}

exercises/practice/square-root/.meta/tests.toml

@@ -0,0 +1,28 @@
+# This is an auto-generated file.
+#
+# Regenerating this file via `configlet sync` will:
+# - Recreate every `description` key/value pair
+# - Recreate every `reimplements` key/value pair, where they exist in problem-specifications
+# - Remove any `include = true` key/value pair (an omitted `include` key implies inclusion)
+# - Preserve any other key/value pair
+#
+# As user-added comments (using the # character) will be removed when this file
+# is regenerated, comments can be added via a `comment` key.
+
+[9b748478-7b0a-490c-b87a-609dacf631fd]
+description = "root of 1"
+
+[7d3aa9ba-9ac6-4e93-a18b-2e8b477139bb]
+description = "root of 4"
+
+[6624aabf-3659-4ae0-a1c8-25ae7f33c6ef]
+description = "root of 25"
+
+[93beac69-265e-4429-abb1-94506b431f81]
+description = "root of 81"
+
+[fbddfeda-8c4f-4bc4-87ca-6991af35360e]
+description = "root of 196"
+
+[c03d0532-8368-4734-a8e0-f96a9eb7fc1d]
+description = "root of 65025"

exercises/practice/square-root/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "arcanis.vscode-zipfs",
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode"
+  ]
+}

exercises/practice/square-root/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "cSpell.words": ["exercism"],
+  "search.exclude": {
+    "**/.yarn": true,
+    "**/.pnp.*": true
+  }
+}

exercises/practice/square-root/.yarnrc.yml

@@ -0,0 +1,3 @@
+compressionLevel: mixed
+
+enableGlobalCache: true

exercises/practice/square-root/babel.config.cjs

@@ -0,0 +1,5 @@
+module.exports = {
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
+  presets: [[require('@exercism/babel-preset-typescript'), { corejs: '3.38' }]],
+  plugins: [],
+}